ITextFrameFormat class

ITextFrameFormat class

Contains the TextFrame’s formatting properties.

The ITextFrameFormat type exposes the following members:

Properties

PropertyDescription
text_styleReturns text’s style.
Read-only ITextStyle.
margin_leftReturns or sets the left margin (points) in a TextFrame.
Read/write float.
margin_rightReturns or sets the right margin (points) in a TextFrame.
Read/write float.
margin_topReturns or sets the top margin (points) in a TextFrame.
Read/write float.
margin_bottomReturns or sets the bottom margin (points) in a TextFrame.
Read/write float.
wrap_textTrue if text is wrapped at TextFrame’s margins.
Read/write NullableBool.
anchoring_typeReturns or sets vertical anchor text in a TextFrame.
Read/write TextAnchorType.
center_textIf NullableBool.True then text should be centered in box horizontally.
Read/write NullableBool.
text_vertical_typeDetermines text orientation.
The resulted value of visual text rotation summarized from this property and custom angle
in property RotationAngle.
Read/write TextVerticalType.
autofit_typeReturns or sets text’s autofit mode.
Read/write TextAutofitType.
column_countReturns 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.
column_spacingReturns 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 float.
three_d_formatReturns the ThreeDFormat object that represents 3d effect properties for a text.
Read-only IThreeDFormat.
keep_text_flatReturns or set keeping text out of 3D scene entirely.
Read/write bool.
rotation_angleSpecifies 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.
transformGets or sets text wrapping shape.
Read/write TextShapeType.

Methods

MethodDescription
get_effectiveGets effective text frame formatting data with the inheritance applied.

See Also