ParagraphFormat

ParagraphFormat class

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 ParagraphFormat#getEffective method which returns a IParagraphFormatEffectiveData instance.

ParagraphFormat

NameDescription
ParagraphFormat()Initializes a new instance of ParagraphFormat class.

Returns: ParagraphFormat


getAlignment

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

Returns: int


getBullet

NameDescription
getBullet ()Returns bullet format of the paragraph. Read-only IBulletFormat.

Returns: BulletFormat


getDefaultPortionFormat

NameDescription
getDefaultPortionFormat ()Returns default portion format of a paragraph. No inheritance applied. Read-only IPortionFormat.

Returns: PortionFormat


getDefaultTabSize

NameDescription
getDefaultTabSize ()Returns or sets default tabulation size with no inheritance. Read/write float.

Returns: float


getDepth

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

Returns: short


getEastAsianLineBreak

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

Returns: byte


getEffective

NameDescription
getEffective ()Gets effective paragraph formatting data with the inheritance applied.

Returns: ParagraphFormatEffectiveData


getFontAlignment

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

Returns: int


getHangingPunctuation

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

Returns: byte


getIndent

NameDescription
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


getLatinLineBreak

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

Returns: byte


getMarginLeft

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

Returns: float


getMarginRight

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

Returns: float


getRightToLeft

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

Returns: byte


getSpaceAfter

NameDescription
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


getSpaceBefore

NameDescription
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


getSpaceWithin

NameDescription
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


getTabs

NameDescription
getTabs ()Returns tabulations of a paragraph. No inheritance applied. Read-only ITabCollection.

Returns: TabCollection


getVersion

NameDescription
getVersion ()

Returns: long


setAlignment

NameDescription
setAlignment (int)Returns or sets the text alignment in a paragraph with no inheritance. Read/write TextAlignment.

Returns: void


setDefaultTabSize

NameDescription
setDefaultTabSize (float)Returns or sets default tabulation size with no inheritance. Read/write float.

Returns: void


setDepth

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

Returns: void


setEastAsianLineBreak

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

Returns: void


setFontAlignment

NameDescription
setFontAlignment (int)Returns or sets a font alignment in a paragraph with no inheritance. Read/write FontAlignment.

Returns: void


setHangingPunctuation

NameDescription
setHangingPunctuation (byte)Determines whether the hanging punctuation is used in a paragraph. No inheritance applied. Read/write NullableBool.

Returns: void


setIndent

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

Returns: void


setLatinLineBreak

NameDescription
setLatinLineBreak (byte)Determines whether the Latin line break is used in a paragraph. No inheritance applied. Read/write NullableBool.

Returns: void


setMarginLeft

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

Returns: void


setMarginRight

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

Returns: void


setRightToLeft

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

Returns: void


setSpaceAfter

NameDescription
setSpaceAfter (float)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: void


setSpaceBefore

NameDescription
setSpaceBefore (float)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: void


setSpaceWithin

NameDescription
setSpaceWithin (float)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: void