TextFrameFormat

TextFrameFormat class

Contains the TextFrame’s formatTextFrameFormatting properties.

TextFrameFormat

NameDescription
TextFrameFormat()Initializes a new instance of TextFrameFormat class.

Returns: TextFrameFormat


getAnchoringType

NameDescription
getAnchoringType ()Returns or sets vertical anchor text in a TextFrameEx. Read/write TextAnchorType.

Returns: byte


getAutofitType

NameDescription
getAutofitType ()Returns or sets text’s autofit mode. Read/write TextAutofitType.

Returns: byte


getCenterText

NameDescription
getCenterText ()If NullableBool.True then text should be centered in box horizontally. Read/write NullableBool.

Returns: byte


getColumnCount

NameDescription
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

NameDescription
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

NameDescription
getEffective ()Gets effective text frame formatting data with the inheritance applied.

Returns: TextFrameFormatEffectiveData


getKeepTextFlat

NameDescription
getKeepTextFlat ()Gets or sets keeping text flat even if a 3-D Rotation effect was applied. Read/write boolean.

Returns: boolean


getMarginBottom

NameDescription
getMarginBottom ()Returns or sets the bottom margin (points) in a TextFrame. Read/write double.

Returns: double


getMarginLeft

NameDescription
getMarginLeft ()Returns or sets the left margin (points) in a TextFrame. Read/write double.

Returns: double


getMarginRight

NameDescription
getMarginRight ()Returns or sets the right margin (points) in a TextFrame. Read/write double.

Returns: double


getMarginTop

NameDescription
getMarginTop ()Returns or sets the top margin (points) in a TextFrame. Read/write double.

Returns: double


getRotationAngle

NameDescription
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

NameDescription
getTextStyle ()Returns text’s style. Read-only ITextStyle.

Returns: TextStyle


getTextVerticalType

NameDescription
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


getThreeDFormat

NameDescription
getThreeDFormat ()Returns the ThreeDFormat object that represents 3d effect properties for a text. Read-only IThreeDFormat.

Returns: ThreeDFormat


getTransform

NameDescription
getTransform ()Gets or sets text wrapping shape. Read/write TextShapeType.

Returns: byte


getVersion

NameDescription
getVersion ()

Returns: long


getWrapText

NameDescription
getWrapText ()True if text is wrapped at TextFrame’s margins. Read/write NullableBool.

Returns: byte


setAnchoringType

NameDescription
setAnchoringType (byte)Returns or sets vertical anchor text in a TextFrameEx. Read/write TextAnchorType.

Returns: void


setAutofitType

NameDescription
setAutofitType (byte)Returns or sets text’s autofit mode. Read/write TextAutofitType.

Returns: void


setCenterText

NameDescription
setCenterText (byte)If NullableBool.True then text should be centered in box horizontally. Read/write NullableBool.

Returns: void


setColumnCount

NameDescription
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.

Returns: void


setColumnSpacing

NameDescription
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.

Returns: void


setKeepTextFlat

NameDescription
setKeepTextFlat (boolean)Gets or sets keeping text flat even if a 3-D Rotation effect was applied. Read/write boolean.

Returns: void


setMarginBottom

NameDescription
setMarginBottom (double)Returns or sets the bottom margin (points) in a TextFrame. Read/write double.

Returns: void


setMarginLeft

NameDescription
setMarginLeft (double)Returns or sets the left margin (points) in a TextFrame. Read/write double.

Returns: void


setMarginRight

NameDescription
setMarginRight (double)Returns or sets the right margin (points) in a TextFrame. Read/write double.

Returns: void


setMarginTop

NameDescription
setMarginTop (double)Returns or sets the top margin (points) in a TextFrame. Read/write double.

Returns: void


setRotationAngle

NameDescription
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.

Returns: void


setTextVerticalType

NameDescription
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.

Returns: void


setTransform

NameDescription
setTransform (byte)Gets or sets text wrapping shape. Read/write TextShapeType.

Returns: void


setWrapText

NameDescription
setWrapText (byte)True if text is wrapped at TextFrame’s margins. Read/write NullableBool.

Returns: void