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
| Name | Description |
|---|---|
| ParagraphFormat() | Initializes a new instance of ParagraphFormat class. |
Returns: ParagraphFormat
getAlignment
| Name | Description |
|---|---|
| getAlignment () | Returns or sets the text alignment in a paragraph with no inheritance. Read/write TextAlignment. |
Returns: int
getBullet
| Name | Description |
|---|---|
| getBullet () | Returns bullet format of the paragraph. Read-only IBulletFormat. |
Returns: BulletFormat
getDefaultPortionFormat
| Name | Description |
|---|---|
| getDefaultPortionFormat () | Returns default portion format of a paragraph. No inheritance applied. Read-only IPortionFormat. |
Returns: PortionFormat
getDefaultTabSize
| Name | Description |
|---|---|
| getDefaultTabSize () | Returns or sets default tabulation size with no inheritance. Read/write float. |
Returns: float
getDepth
| Name | Description |
|---|---|
| getDepth () | Returns or sets depth of the paragraph. Value 0 means undefined value. Read/write short. |
Returns: short
getEastAsianLineBreak
| Name | Description |
|---|---|
| getEastAsianLineBreak () | Determines whether the East Asian line break is used in a paragraph. No inheritance applied. Read/write NullableBool. |
Returns: byte
getEffective
| Name | Description |
|---|---|
| getEffective () | Gets effective paragraph formatting data with the inheritance applied. |
Returns: ParagraphFormatEffectiveData
getFontAlignment
| Name | Description |
|---|---|
| getFontAlignment () | Returns or sets a font alignment in a paragraph with no inheritance. Read/write FontAlignment. |
Returns: int
getHangingPunctuation
| Name | Description |
|---|---|
| getHangingPunctuation () | Determines whether the hanging punctuation is used in a paragraph. No inheritance applied. Read/write NullableBool. |
Returns: byte
getIndent
| Name | Description |
|---|---|
| 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
| Name | Description |
|---|---|
| getLatinLineBreak () | Determines whether the Latin line break is used in a paragraph. No inheritance applied. Read/write NullableBool. |
Returns: byte
getMarginLeft
| Name | Description |
|---|---|
| getMarginLeft () | Returns or sets the left margin in a paragraph with no inheritance. Read/write float. |
Returns: float
getMarginRight
| Name | Description |
|---|---|
| getMarginRight () | Returns or sets the right margin in a paragraph with no inheritance. Read/write float. |
Returns: float
getRightToLeft
| Name | Description |
|---|---|
| getRightToLeft () | Determines whether the Right to Left writing is used in a paragraph. No inheritance applied. Read/write NullableBool. |
Returns: byte
getSpaceAfter
| Name | Description |
|---|---|
| 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
| Name | Description |
|---|---|
| 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
| Name | Description |
|---|---|
| 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
| Name | Description |
|---|---|
| getTabs () | Returns tabulations of a paragraph. No inheritance applied. Read-only ITabCollection. |
Returns: TabCollection
getVersion
| Name | Description |
|---|---|
| getVersion () |
Returns: long
setAlignment
| Name | Description |
|---|---|
| setAlignment (int) | Returns or sets the text alignment in a paragraph with no inheritance. Read/write TextAlignment. |
Returns: void
setDefaultTabSize
| Name | Description |
|---|---|
| setDefaultTabSize (float) | Returns or sets default tabulation size with no inheritance. Read/write float. |
Returns: void
setDepth
| Name | Description |
|---|---|
| setDepth (short) | Returns or sets depth of the paragraph. Value 0 means undefined value. Read/write short. |
Returns: void
setEastAsianLineBreak
| Name | Description |
|---|---|
| setEastAsianLineBreak (byte) | Determines whether the East Asian line break is used in a paragraph. No inheritance applied. Read/write NullableBool. |
Returns: void
setFontAlignment
| Name | Description |
|---|---|
| setFontAlignment (int) | Returns or sets a font alignment in a paragraph with no inheritance. Read/write FontAlignment. |
Returns: void
setHangingPunctuation
| Name | Description |
|---|---|
| setHangingPunctuation (byte) | Determines whether the hanging punctuation is used in a paragraph. No inheritance applied. Read/write NullableBool. |
Returns: void
setIndent
| Name | Description |
|---|---|
| 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
| Name | Description |
|---|---|
| setLatinLineBreak (byte) | Determines whether the Latin line break is used in a paragraph. No inheritance applied. Read/write NullableBool. |
Returns: void
setMarginLeft
| Name | Description |
|---|---|
| setMarginLeft (float) | Returns or sets the left margin in a paragraph with no inheritance. Read/write float. |
Returns: void
setMarginRight
| Name | Description |
|---|---|
| setMarginRight (float) | Returns or sets the right margin in a paragraph with no inheritance. Read/write float. |
Returns: void
setRightToLeft
| Name | Description |
|---|---|
| setRightToLeft (byte) | Determines whether the Right to Left writing is used in a paragraph. No inheritance applied. Read/write NullableBool. |
Returns: void
setSpaceAfter
| Name | Description |
|---|---|
| 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
| Name | Description |
|---|---|
| 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
| Name | Description |
|---|---|
| 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