IParagraphFormat class

IParagraphFormat class

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

The IParagraphFormat type exposes the following members:

Properties

PropertyDescription
bulletReturns bullet format of the paragraph.
Read-only IBulletFormat.
depthReturns or sets depth of the paragraph.
Value 0 means undefined value.
Read/write int.
alignmentReturns or sets the text alignment in a paragraph with no inheritance.
Read/write TextAlignment.
space_withinReturns 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.
space_beforeReturns 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.
space_afterReturns 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.
east_asian_line_breakDetermines whether the East Asian line break is used in a paragraph. No inheritance applied.
Read/write NullableBool.
right_to_leftDetermines whether the Right to Left writing is used in a paragraph. No inheritance applied.
Read/write NullableBool.
latin_line_breakDetermines whether the Latin line break is used in a paragraph. No inheritance applied.
Read/write NullableBool.
hanging_punctuationDetermines whether the hanging punctuation is used in a paragraph. No inheritance applied.
Read/write NullableBool.
margin_leftReturns or sets the left margin in a paragraph with no inheritance.
Read/write float.
margin_rightReturns or sets the right margin in a paragraph with no inheritance.
Read/write float.
indentReturns or sets paragraph First Line Indent/Hanging Indent with no inheritance. Hanging Indent can be defined with negative values.
Read/write float.
default_tab_sizeReturns or sets default tabulation size with no inheritance.
Read/write float.
tabsReturns tabulations of a paragraph. No inheritance applied.
Read-only ITabCollection.
font_alignmentReturns or sets a font alignment in a paragraph with no inheritance.
Read/write FontAlignment.
default_portion_formatReturns default portion format of a paragraph. No inheritance applied.
Read-only IPortionFormat.

Methods

MethodDescription
get_effectiveGets effective paragraph formatting data with the inheritance applied.

Remarks

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 IParagraphFormat.get_effective method which returns a IParagraphFormatEffectiveData instance.

See Also