public interface ITextFrameFormat
Contains the TextFrame's formatting properties.
Modifier and Type | Method and Description |
---|---|
byte |
getAnchoringType()
Returns or sets vertical anchor text in a TextFrame.
|
byte |
getAutofitType()
Returns or sets text's autofit mode.
|
byte |
getCenterText()
If NullableBool.True then text should be centered in box horizontally.
|
int |
getColumnCount()
Returns or sets number of columns in the text area.
|
double |
getColumnSpacing()
Returns or sets the space between text columns in the text area (in points).
|
ITextFrameFormatEffectiveData |
getEffective()
Gets effective text frame formatting data with the inheritance applied.
|
double |
getMarginBottom()
Returns or sets the bottom margin (points) in a TextFrame.
|
double |
getMarginLeft()
Returns or sets the left margin (points) in a TextFrame.
|
double |
getMarginRight()
Returns or sets the right margin (points) in a TextFrame.
|
double |
getMarginTop()
Returns or sets the top margin (points) in a TextFrame.
|
float |
getRotationAngle()
Specifies the custom rotation that is being applied to the text within the bounding box.
|
ITextStyle |
getTextStyle()
Returns text's style.
|
byte |
getTextVerticalType()
Determines text orientation.
|
byte |
getWrapText()
<b>True</b> if text is wrapped at TextFrame's margins. |
void |
setAnchoringType(byte value)
Returns or sets vertical anchor text in a TextFrame.
|
void |
setAutofitType(byte value)
Returns or sets text's autofit mode.
|
void |
setCenterText(byte value)
If NullableBool.True then text should be centered in box horizontally.
|
void |
setColumnCount(int value)
Returns or sets number of columns in the text area.
|
void |
setColumnSpacing(double value)
Returns or sets the space between text columns in the text area (in points).
|
void |
setMarginBottom(double value)
Returns or sets the bottom margin (points) in a TextFrame.
|
void |
setMarginLeft(double value)
Returns or sets the left margin (points) in a TextFrame.
|
void |
setMarginRight(double value)
Returns or sets the right margin (points) in a TextFrame.
|
void |
setMarginTop(double value)
Returns or sets the top margin (points) in a TextFrame.
|
void |
setRotationAngle(float value)
Specifies the custom rotation that is being applied to the text within the bounding box.
|
void |
setTextVerticalType(byte value)
Determines text orientation.
|
void |
setWrapText(byte value)
<b>True</b> if text is wrapped at TextFrame's margins. |
ITextStyle getTextStyle()
Returns text's style.
Read-only ITextStyle
.
double getMarginLeft()
Returns or sets the left margin (points) in a TextFrame.
Read/write double
.
void setMarginLeft(double value)
Returns or sets the left margin (points) in a TextFrame.
Read/write double
.
double getMarginRight()
Returns or sets the right margin (points) in a TextFrame.
Read/write double
.
void setMarginRight(double value)
Returns or sets the right margin (points) in a TextFrame.
Read/write double
.
double getMarginTop()
Returns or sets the top margin (points) in a TextFrame.
Read/write double
.
void setMarginTop(double value)
Returns or sets the top margin (points) in a TextFrame.
Read/write double
.
double getMarginBottom()
Returns or sets the bottom margin (points) in a TextFrame.
Read/write double
.
void setMarginBottom(double value)
Returns or sets the bottom margin (points) in a TextFrame.
Read/write double
.
byte getWrapText()
<b>True</b>
if text is wrapped at TextFrame's margins.
Read/write NullableBool
.
void setWrapText(byte value)
<b>True</b>
if text is wrapped at TextFrame's margins.
Read/write NullableBool
.
byte getAnchoringType()
Returns or sets vertical anchor text in a TextFrame.
Read/write TextAnchorType
.
void setAnchoringType(byte value)
Returns or sets vertical anchor text in a TextFrame.
Read/write TextAnchorType
.
byte getCenterText()
If NullableBool.True then text should be centered in box horizontally.
Read/write NullableBool
.
void setCenterText(byte value)
If NullableBool.True then text should be centered in box horizontally.
Read/write NullableBool
.
byte getTextVerticalType()
Determines text orientation.
The resulted value of visual text rotation summarized from this property and custom angle
in property RotationAngle.
Read/write TextVerticalType
.
void setTextVerticalType(byte value)
Determines text orientation.
The resulted value of visual text rotation summarized from this property and custom angle
in property RotationAngle.
Read/write TextVerticalType
.
byte getAutofitType()
Returns or sets text's autofit mode.
Read/write TextAutofitType
.
void setAutofitType(byte value)
Returns or sets text's autofit mode.
Read/write TextAutofitType
.
int getColumnCount()
Returns or sets number of columns in the text area.
This value must be a positive number. Otherwise, the value will be set to zero.
Value 0 means undefined value.
Read/write int
.
void setColumnCount(int value)
Returns or sets number of columns in the text area.
This value must be a positive number. Otherwise, the value will be set to zero.
Value 0 means undefined value.
Read/write int
.
double getColumnSpacing()
Returns or sets the space between text columns in the text area (in points). This should only apply
when there is more than 1 column present.
This value must be a positive number. Otherwise, the value will be set to zero.
Read/write double
.
void setColumnSpacing(double value)
Returns or sets the space between text columns in the text area (in points). This should only apply
when there is more than 1 column present.
This value must be a positive number. Otherwise, the value will be set to zero.
Read/write double
.
float getRotationAngle()
Specifies the custom rotation that is being applied to the text within the bounding box. If it not
specified, the rotation of the accompanying shape is used. If it is specified, then this is
applied independently from the shape. That is the shape can have a rotation applied in
addition to the text itself having a rotation applied to it.
The resulted value of visual text rotation summarized from this property and predefined
vertical type in property TextVerticalType.
Read/write float
.
Consider the case where a shape has a rotation of 90 degrees clockwise applied to it. In addition to this, the text body itself has a rotation of -90 degrees counter-clockwise applied to it. Then the resulting shape would appear to be rotated but the text within it would appear as though it had not been rotated at all.
void setRotationAngle(float value)
Specifies the custom rotation that is being applied to the text within the bounding box. If it not
specified, the rotation of the accompanying shape is used. If it is specified, then this is
applied independently from the shape. That is the shape can have a rotation applied in
addition to the text itself having a rotation applied to it.
The resulted value of visual text rotation summarized from this property and predefined
vertical type in property TextVerticalType.
Read/write float
.
Consider the case where a shape has a rotation of 90 degrees clockwise applied to it. In addition to this, the text body itself has a rotation of -90 degrees counter-clockwise applied to it. Then the resulting shape would appear to be rotated but the text within it would appear as though it had not been rotated at all.
ITextFrameFormatEffectiveData getEffective()
Gets effective text frame formatting data with the inheritance applied.
ITextFrameFormatEffectiveData
.