TextFrameFormat
TextFrameFormat class
Contains the TextFrame’s formatTextFrameFormatting properties.
TextFrameFormat
| Name | Description |
|---|
| TextFrameFormat() | Initializes a new instance of TextFrameFormat class. |
Returns:
TextFrameFormat
getAnchoringType
| Name | Description |
|---|
| getAnchoringType () | Returns or sets vertical anchor text in a TextFrame. Read/write TextAnchorType. |
Returns:
byte
getAutofitType
| Name | Description |
|---|
| getAutofitType () | Returns or sets text’s autofit mode. Read/write TextAutofitType. |
Returns:
byte
getCenterText
| Name | Description |
|---|
| getCenterText () | If NullableBool.True then text should be centered in box horizontally. Read/write NullableBool. |
Returns:
byte
getColumnCount
| Name | Description |
|---|
| 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. |
Returns:
int
getColumnSpacing
| Name | Description |
|---|
| 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. |
Returns:
double
getEffective
| Name | Description |
|---|
| getEffective () | Gets effective text frame formatting data with the inheritance applied. |
Returns:
TextFrameFormatEffectiveData
getKeepTextFlat
| Name | Description |
|---|
| getKeepTextFlat () | Gets or sets keeping text flat even if a 3-D Rotation effect was applied. Read/write boolean. |
Returns:
boolean
getMarginBottom
| Name | Description |
|---|
| getMarginBottom () | Returns or sets the bottom margin (points) in a TextFrame. Read/write double. |
Returns:
double
getMarginLeft
| Name | Description |
|---|
| getMarginLeft () | Returns or sets the left margin (points) in a TextFrame. Read/write double. |
Returns:
double
getMarginRight
| Name | Description |
|---|
| getMarginRight () | Returns or sets the right margin (points) in a TextFrame. Read/write double. |
Returns:
double
getMarginTop
| Name | Description |
|---|
| getMarginTop () | Returns or sets the top margin (points) in a TextFrame. Read/write double. |
Returns:
double
getRotationAngle
| Name | Description |
|---|
| getRotationAngle () | Specifies custom the 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. |
Returns:
float
getTextStyle
| Name | Description |
|---|
| getTextStyle () | Returns text’s style. Read-only ITextStyle. |
Returns:
TextStyle
getTextVerticalType
| Name | Description |
|---|
| getTextVerticalType () | Determines text orientation. The resulted value of visual text rotation summarized from this property and custom angle in property RotationAngle. Read/write TextVerticalType. |
Returns:
byte
| Name | Description |
|---|
| getThreeDFormat () | Returns the ThreeDFormat object that represents 3d effect properties for a text. Read-only IThreeDFormat. |
Returns:
ThreeDFormat
| Name | Description |
|---|
| getTransform () | Gets or sets text wrapping shape. Read/write TextShapeType. |
Returns:
byte
getVersion
| Name | Description |
|---|
| getVersion () | |
Returns:
long
getWrapText
| Name | Description |
|---|
| getWrapText () | True if text is wrapped at TextFrame’s margins. Read/write NullableBool. |
Returns:
byte
setAnchoringType
| Name | Description |
|---|
| setAnchoringType (byte) | Returns or sets vertical anchor text in a TextFrame. Read/write TextAnchorType. |
setAutofitType
| Name | Description |
|---|
| setAutofitType (byte) | Returns or sets text’s autofit mode. Read/write TextAutofitType. |
setCenterText
| Name | Description |
|---|
| setCenterText (byte) | If NullableBool.True then text should be centered in box horizontally. Read/write NullableBool. |
setColumnCount
| Name | Description |
|---|
| setColumnCount (int) | 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. |
setColumnSpacing
| Name | Description |
|---|
| setColumnSpacing (double) | 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. |
setKeepTextFlat
| Name | Description |
|---|
| setKeepTextFlat (boolean) | Gets or sets keeping text flat even if a 3-D Rotation effect was applied. Read/write boolean. |
setMarginBottom
| Name | Description |
|---|
| setMarginBottom (double) | Returns or sets the bottom margin (points) in a TextFrame. Read/write double. |
setMarginLeft
| Name | Description |
|---|
| setMarginLeft (double) | Returns or sets the left margin (points) in a TextFrame. Read/write double. |
setMarginRight
| Name | Description |
|---|
| setMarginRight (double) | Returns or sets the right margin (points) in a TextFrame. Read/write double. |
setMarginTop
| Name | Description |
|---|
| setMarginTop (double) | Returns or sets the top margin (points) in a TextFrame. Read/write double. |
setRotationAngle
| Name | Description |
|---|
| setRotationAngle (float) | Specifies custom the 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. |
setTextVerticalType
| Name | Description |
|---|
| setTextVerticalType (byte) | Determines text orientation. The resulted value of visual text rotation summarized from this property and custom angle in property RotationAngle. Read/write TextVerticalType. |
| Name | Description |
|---|
| setTransform (byte) | Gets or sets text wrapping shape. Read/write TextShapeType. |
setWrapText
| Name | Description |
|---|
| setWrapText (byte) | True if text is wrapped at TextFrame’s margins. Read/write NullableBool. |