IParagraphFormat

public interface IParagraphFormat

This class contains the paragraph formatting properties. Unlike IParagraphFormatEffectiveData, all properties of this class are writeable.


This class is used to return and manipulate paragraph formatting properties defined for the particular paragraph. This means that no inheritance is applied when getting values so for the majority of cases you will get values meaning “undefined”.

In order to get the effective formatting parameter values including inherited you need to use getEffective method which returns a IParagraphFormatEffectiveData instance.

Methods

Method Description
getBullet() Returns bullet format of the paragraph.
getDepth() Returns or sets depth of the paragraph.
setDepth(short value) Returns or sets depth of the paragraph.
getAlignment() Returns or sets the text alignment in a paragraph with no inheritance.
setAlignment(int value) Returns or sets the text alignment in a paragraph with no inheritance.
getSpaceWithin() Returns or sets the amount of space between base lines in a paragraph.
setSpaceWithin(float value) Returns or sets the amount of space between base lines in a paragraph.
getSpaceBefore() Returns or sets the amount of space before the first line in a paragraph with no inheritance.
setSpaceBefore(float value) Returns or sets the amount of space before the first line in a paragraph with no inheritance.
getSpaceAfter() Returns or sets the amount of space after the last line in a paragraph with no inheritance.
setSpaceAfter(float value) Returns or sets the amount of space after the last line in a paragraph with no inheritance.
getEastAsianLineBreak() Determines whether the East Asian line break is used in a paragraph.
setEastAsianLineBreak(byte value) Determines whether the East Asian line break is used in a paragraph.
getRightToLeft() Determines whether the Right to Left writing is used in a paragraph.
setRightToLeft(byte value) Determines whether the Right to Left writing is used in a paragraph.
getLatinLineBreak() Determines whether the Latin line break is used in a paragraph.
setLatinLineBreak(byte value) Determines whether the Latin line break is used in a paragraph.
getHangingPunctuation() Determines whether the hanging punctuation is used in a paragraph.
setHangingPunctuation(byte value) Determines whether the hanging punctuation is used in a paragraph.
getMarginLeft() Returns or sets the left margin in a paragraph with no inheritance.
setMarginLeft(float value) Returns or sets the left margin in a paragraph with no inheritance.
getMarginRight() Returns or sets the right margin in a paragraph with no inheritance.
setMarginRight(float value) Returns or sets the right margin in a paragraph with no inheritance.
getIndent() Returns or sets paragraph First Line Indent/Hanging Indent with no inheritance.
setIndent(float value) Returns or sets paragraph First Line Indent/Hanging Indent with no inheritance.
getDefaultTabSize() Returns or sets default tabulation size with no inheritance.
setDefaultTabSize(float value) Returns or sets default tabulation size with no inheritance.
getTabs() Returns tabulations of a paragraph.
getFontAlignment() Returns or sets a font alignment in a paragraph with no inheritance.
setFontAlignment(int value) Returns or sets a font alignment in a paragraph with no inheritance.
getDefaultPortionFormat() Returns default portion format of a paragraph.
getEffective() Gets effective paragraph formatting data with the inheritance applied.

getBullet()

public abstract IBulletFormat getBullet()

Returns bullet format of the paragraph. Read-only IBulletFormat.

Returns: IBulletFormat

getDepth()

public abstract short getDepth()

Returns or sets depth of the paragraph. Value 0 means undefined value. Read/write short.

Returns: short

setDepth(short value)

public abstract void setDepth(short value)

Returns or sets depth of the paragraph. Value 0 means undefined value. Read/write short.

Parameters:

Parameter Type Description
value short

getAlignment()

public abstract int getAlignment()

Returns or sets the text alignment in a paragraph with no inheritance. Read/write TextAlignment.

Returns: int

setAlignment(int value)

public abstract void setAlignment(int value)

Returns or sets the text alignment in a paragraph with no inheritance. Read/write TextAlignment.

Parameters:

Parameter Type Description
value int

getSpaceWithin()

public abstract float getSpaceWithin()

Returns or sets the amount of space between base lines in a paragraph. Positive value means percentage, negative - size in points. No inheritance applied. Read/write float.

Returns: float

setSpaceWithin(float value)

public abstract void setSpaceWithin(float value)

Returns or sets the amount of space between base lines in a paragraph. Positive value means percentage, negative - size in points. No inheritance applied. Read/write float.

Parameters:

Parameter Type Description
value float

getSpaceBefore()

public abstract float getSpaceBefore()

Returns or sets the amount of space before the first line in a paragraph with no inheritance. A positive value specifies the percentage of the font size that the white space should be. A negative value specifies the size of the white space in point size. Read/write float.

Returns: float

setSpaceBefore(float value)

public abstract void setSpaceBefore(float value)

Returns or sets the amount of space before the first line in a paragraph with no inheritance. A positive value specifies the percentage of the font size that the white space should be. A negative value specifies the size of the white space in point size. Read/write float.

Parameters:

Parameter Type Description
value float

getSpaceAfter()

public abstract float getSpaceAfter()

Returns or sets the amount of space after the last line in a paragraph with no inheritance. A positive value specifies the percentage of the font size that the white space should be. A negative value specifies the size of the white space in point size. Read/write float.

Returns: float

setSpaceAfter(float value)

public abstract void setSpaceAfter(float value)

Returns or sets the amount of space after the last line in a paragraph with no inheritance. A positive value specifies the percentage of the font size that the white space should be. A negative value specifies the size of the white space in point size. Read/write float.

Parameters:

Parameter Type Description
value float

getEastAsianLineBreak()

public abstract byte getEastAsianLineBreak()

Determines whether the East Asian line break is used in a paragraph. No inheritance applied. Read/write NullableBool.

Returns: byte

setEastAsianLineBreak(byte value)

public abstract void setEastAsianLineBreak(byte value)

Determines whether the East Asian line break is used in a paragraph. No inheritance applied. Read/write NullableBool.

Parameters:

Parameter Type Description
value byte

getRightToLeft()

public abstract byte getRightToLeft()

Determines whether the Right to Left writing is used in a paragraph. No inheritance applied. Read/write NullableBool.

Returns: byte

setRightToLeft(byte value)

public abstract void setRightToLeft(byte value)

Determines whether the Right to Left writing is used in a paragraph. No inheritance applied. Read/write NullableBool.

Parameters:

Parameter Type Description
value byte

getLatinLineBreak()

public abstract byte getLatinLineBreak()

Determines whether the Latin line break is used in a paragraph. No inheritance applied. Read/write NullableBool.

Returns: byte

setLatinLineBreak(byte value)

public abstract void setLatinLineBreak(byte value)

Determines whether the Latin line break is used in a paragraph. No inheritance applied. Read/write NullableBool.

Parameters:

Parameter Type Description
value byte

getHangingPunctuation()

public abstract byte getHangingPunctuation()

Determines whether the hanging punctuation is used in a paragraph. No inheritance applied. Read/write NullableBool.

Returns: byte

setHangingPunctuation(byte value)

public abstract void setHangingPunctuation(byte value)

Determines whether the hanging punctuation is used in a paragraph. No inheritance applied. Read/write NullableBool.

Parameters:

Parameter Type Description
value byte

getMarginLeft()

public abstract float getMarginLeft()

Returns or sets the left margin in a paragraph with no inheritance. Read/write float.

Returns: float

setMarginLeft(float value)

public abstract void setMarginLeft(float value)

Returns or sets the left margin in a paragraph with no inheritance. Read/write float.

Parameters:

Parameter Type Description
value float

getMarginRight()

public abstract float getMarginRight()

Returns or sets the right margin in a paragraph with no inheritance. Read/write float.

Returns: float

setMarginRight(float value)

public abstract void setMarginRight(float value)

Returns or sets the right margin in a paragraph with no inheritance. Read/write float.

Parameters:

Parameter Type Description
value float

getIndent()

public abstract float getIndent()

Returns or sets paragraph First Line Indent/Hanging Indent with no inheritance. Hanging Indent can be defined with negative values. Read/write float.

Returns: float

setIndent(float value)

public abstract void setIndent(float value)

Returns or sets paragraph First Line Indent/Hanging Indent with no inheritance. Hanging Indent can be defined with negative values. Read/write float.

Parameters:

Parameter Type Description
value float

getDefaultTabSize()

public abstract float getDefaultTabSize()

Returns or sets default tabulation size with no inheritance. Read/write float.

Returns: float

setDefaultTabSize(float value)

public abstract void setDefaultTabSize(float value)

Returns or sets default tabulation size with no inheritance. Read/write float.

Parameters:

Parameter Type Description
value float

getTabs()

public abstract ITabCollection getTabs()

Returns tabulations of a paragraph. No inheritance applied. Read-only ITabCollection.

Returns: ITabCollection

getFontAlignment()

public abstract int getFontAlignment()

Returns or sets a font alignment in a paragraph with no inheritance. Read/write FontAlignment.

Returns: int

setFontAlignment(int value)

public abstract void setFontAlignment(int value)

Returns or sets a font alignment in a paragraph with no inheritance. Read/write FontAlignment.

Parameters:

Parameter Type Description
value int

getDefaultPortionFormat()

public abstract IPortionFormat getDefaultPortionFormat()

Returns default portion format of a paragraph. No inheritance applied. Read-only IPortionFormat.

Returns: IPortionFormat

getEffective()

public abstract IParagraphFormatEffectiveData getEffective()

Gets effective paragraph formatting data with the inheritance applied.

Returns: IParagraphFormatEffectiveData - A IParagraphFormatEffectiveData.