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.
Modifier and Type | Method and Description |
---|---|
int |
getAlignment()
Returns or sets the text alignment in a paragraph with no inheritance.
|
IBulletFormat |
getBullet()
Returns bullet format of the paragraph.
|
IPortionFormat |
getDefaultPortionFormat()
Returns default portion format of a paragraph.
|
float |
getDefaultTabSize()
Returns or sets default tabulation size with no inheritance.
|
short |
getDepth()
Returns or sets depth of the paragraph.
|
byte |
getEastAsianLineBreak()
Determines whether the East Asian line break is used in a paragraph.
|
IParagraphFormatEffectiveData |
getEffective()
Gets effective paragraph formatting data with the inheritance applied.
|
int |
getFontAlignment()
Returns or sets a font alignment in a paragraph with no inheritance.
|
byte |
getHangingPunctuation()
Determines whether the hanging punctuation is used in a paragraph.
|
float |
getIndent()
Returns or sets paragraph First Line Indent/Hanging Indent with no inheritance.
|
byte |
getLatinLineBreak()
Determines whether the Latin line break is used in a paragraph.
|
float |
getMarginLeft()
Returns or sets the left margin in a paragraph with no inheritance.
|
float |
getMarginRight()
Returns or sets the right margin in a paragraph with no inheritance.
|
byte |
getRightToLeft()
Determines whether the Right to Left writing is used in a paragraph.
|
float |
getSpaceAfter()
Returns or sets the amount of space after the last line in a paragraph with no inheritance.
|
float |
getSpaceBefore()
Returns or sets the amount of space before the first line in a paragraph with no inheritance.
|
float |
getSpaceWithin()
Returns or sets the amount of space between base lines in a paragraph.
|
ITabCollection |
getTabs()
Returns tabulations of a paragraph.
|
void |
setAlignment(int value)
Returns or sets the text alignment in a paragraph with no inheritance.
|
void |
setDefaultTabSize(float value)
Returns or sets default tabulation size with no inheritance.
|
void |
setDepth(short value)
Returns or sets depth of the paragraph.
|
void |
setEastAsianLineBreak(byte value)
Determines whether the East Asian line break is used in a paragraph.
|
void |
setFontAlignment(int value)
Returns or sets a font alignment in a paragraph with no inheritance.
|
void |
setHangingPunctuation(byte value)
Determines whether the hanging punctuation is used in a paragraph.
|
void |
setIndent(float value)
Returns or sets paragraph First Line Indent/Hanging Indent with no inheritance.
|
void |
setLatinLineBreak(byte value)
Determines whether the Latin line break is used in a paragraph.
|
void |
setMarginLeft(float value)
Returns or sets the left margin in a paragraph with no inheritance.
|
void |
setMarginRight(float value)
Returns or sets the right margin in a paragraph with no inheritance.
|
void |
setRightToLeft(byte value)
Determines whether the Right to Left writing is used in a paragraph.
|
void |
setSpaceAfter(float value)
Returns or sets the amount of space after the last line in a paragraph with no inheritance.
|
void |
setSpaceBefore(float value)
Returns or sets the amount of space before the first line in a paragraph with no inheritance.
|
void |
setSpaceWithin(float value)
Returns or sets the amount of space between base lines in a paragraph.
|
IBulletFormat getBullet()
Returns bullet format of the paragraph.
Read-only IBulletFormat
.
short getDepth()
Returns or sets depth of the paragraph.
Value 0 means undefined value.
Read/write short
.
void setDepth(short value)
Returns or sets depth of the paragraph.
Value 0 means undefined value.
Read/write short
.
int getAlignment()
Returns or sets the text alignment in a paragraph with no inheritance.
Read/write TextAlignment
.
void setAlignment(int value)
Returns or sets the text alignment in a paragraph with no inheritance.
Read/write TextAlignment
.
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
.
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
.
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
.
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
.
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
.
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
.
byte getEastAsianLineBreak()
Determines whether the East Asian line break is used in a paragraph. No inheritance applied.
Read/write NullableBool
.
void setEastAsianLineBreak(byte value)
Determines whether the East Asian line break is used in a paragraph. No inheritance applied.
Read/write NullableBool
.
byte getRightToLeft()
Determines whether the Right to Left writing is used in a paragraph. No inheritance applied.
Read/write NullableBool
.
void setRightToLeft(byte value)
Determines whether the Right to Left writing is used in a paragraph. No inheritance applied.
Read/write NullableBool
.
byte getLatinLineBreak()
Determines whether the Latin line break is used in a paragraph. No inheritance applied.
Read/write NullableBool
.
void setLatinLineBreak(byte value)
Determines whether the Latin line break is used in a paragraph. No inheritance applied.
Read/write NullableBool
.
byte getHangingPunctuation()
Determines whether the hanging punctuation is used in a paragraph. No inheritance applied.
Read/write NullableBool
.
void setHangingPunctuation(byte value)
Determines whether the hanging punctuation is used in a paragraph. No inheritance applied.
Read/write NullableBool
.
float getMarginLeft()
Returns or sets the left margin in a paragraph with no inheritance.
Read/write float
.
void setMarginLeft(float value)
Returns or sets the left margin in a paragraph with no inheritance.
Read/write float
.
float getMarginRight()
Returns or sets the right margin in a paragraph with no inheritance.
Read/write float
.
void setMarginRight(float value)
Returns or sets the right margin in a paragraph with no inheritance.
Read/write float
.
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
.
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
.
float getDefaultTabSize()
Returns or sets default tabulation size with no inheritance.
Read/write float
.
void setDefaultTabSize(float value)
Returns or sets default tabulation size with no inheritance.
Read/write float
.
ITabCollection getTabs()
Returns tabulations of a paragraph. No inheritance applied.
Read-only ITabCollection
.
int getFontAlignment()
Returns or sets a font alignment in a paragraph with no inheritance.
Read/write FontAlignment
.
void setFontAlignment(int value)
Returns or sets a font alignment in a paragraph with no inheritance.
Read/write FontAlignment
.
IPortionFormat getDefaultPortionFormat()
Returns default portion format of a paragraph. No inheritance applied.
Read-only IPortionFormat
.
IParagraphFormatEffectiveData getEffective()
Gets effective paragraph formatting data with the inheritance applied.
IParagraphFormatEffectiveData
.