ITextFrameFormatEffectiveData

public interface ITextFrameFormatEffectiveData

Immutable object which contains effective text frame formatting properties.


This interface is used together with the ITextFrameFormat interface to return effective formatting values with inheritance applied.

Methods

MethodDescription
getTextStyle()Returns effective text’s style.
getMarginLeft()Returns the left margin (points) in a TextFrame.
getMarginRight()Returns the right margin (points) in a TextFrame.
getMarginTop()Returns the top margin (points) in a TextFrame.
getMarginBottom()Returns the bottom margin (points) in a TextFrame.
getWrapText()Returns if text is wrapped at TextFrame’s margins.
getAnchoringType()Returns vertical anchor text in a TextFrame.
getCenterText()Returns if text should be centered in box horizontally.
getTextVerticalType()Returns text orientation.
getAutofitType()Returns text autofit mode.
getColumnCount()Specifies the number of columns of text in the bounding rectangle.
getColumnSpacing()Specifies the space between text columns in the text area (in points).

getTextStyle()

public abstract ITextStyleEffectiveData getTextStyle()

Returns effective text’s style. Read-only ITextStyleEffectiveData.

Returns: ITextStyleEffectiveData

getMarginLeft()

public abstract double getMarginLeft()

Returns the left margin (points) in a TextFrame. Read-only double.

Returns: double

getMarginRight()

public abstract double getMarginRight()

Returns the right margin (points) in a TextFrame. Read-only double.

Returns: double

getMarginTop()

public abstract double getMarginTop()

Returns the top margin (points) in a TextFrame. Read-only double.

Returns: double

getMarginBottom()

public abstract double getMarginBottom()

Returns the bottom margin (points) in a TextFrame. Read-only double.

Returns: double

getWrapText()

public abstract boolean getWrapText()

Returns if text is wrapped at TextFrame’s margins. Read-only boolean.

Returns: boolean

getAnchoringType()

public abstract byte getAnchoringType()

Returns vertical anchor text in a TextFrame. Read-only TextAnchorType.

Returns: byte

getCenterText()

public abstract boolean getCenterText()

Returns if text should be centered in box horizontally. Read-only boolean.

Returns: boolean

getTextVerticalType()

public abstract byte getTextVerticalType()

Returns text orientation. Read-only TextVerticalType.

Returns: byte

getAutofitType()

public abstract byte getAutofitType()

Returns text autofit mode. Read-only TextAutofitType.

Returns: byte

getColumnCount()

public abstract int getColumnCount()

Specifies the number of columns of text in the bounding rectangle. Read-only int.

Returns: int

getColumnSpacing()

public abstract float getColumnSpacing()

Specifies the space between text columns in the text area (in points). Read-only float.

Returns: float