com.spire.presentation
Interface ITextFrameProperties

public interface ITextFrameProperties

Method Summary

void	dispose() Dispose object and free resources.
TextAnchorType	getAnchoringType() Gets vertical anchor text in a TextFrame.
TextAutofitType	getAutofitType() Gets text's autofit mode.
double	getMarginBottom() Gets the bottom margin (points) in a TextFrame.
double	getMarginLeft() Gets the left margin (points) in a TextFrame.
double	getMarginRight() Gets the right margin (points) in a TextFrame.
double	getMarginTop() Gets the top margin (points) in a TextFrame.
ParagraphCollection	getParagraphs() Gets the list of all paragraphs in a frame.
java.lang.Object	getParent() Reference to Parent object.
Presentation	getPresentation()
float	getRotationAngle() Gets the rotation angle of text frame .
ActiveSlide	getSlide() Gets the parent slide of a TextFrame.
java.lang.String	getText() Gets the plain text for a TextFrame.
PortionEx	getTextRange() Text range of text frame.
TextStyle	getTextStyle() Gets text's style.
FormatThreeD	getTextThreeD() Gets the FormatThreeD object that 3d effect properties for text.
VerticalTextType	getVerticalTextType() Indicates text orientation.
boolean	getWordWrap() True if text is wrapped at TextFrame's margins.
boolean	isCentered() Indicates, whether text should be centered in box horizontally.
void	isCentered(boolean value)
void	setAnchoringType(TextAnchorType value) Sets vertical anchor text in a TextFrame.
void	setAutofitType(TextAutofitType value) Sets text's autofit mode.
void	setMarginBottom(double value) Sets the bottom margin (points) in a TextFrame.
void	setMarginLeft(double value) Sets the left margin (points) in a TextFrame.
void	setMarginRight(double value) Sets the right margin (points) in a TextFrame.
void	setMarginTop(double value) Sets the top margin (points) in a TextFrame.
void	setRotationAngle(float value) Sets the rotation angle of text frame .
void	setText(java.lang.String value) Sets the plain text for a TextFrame.
void	setVerticalTextType(VerticalTextType value)
void	setWordWrap(boolean value)

Method Detail

getParagraphs

ParagraphCollection getParagraphs()

Gets the list of all paragraphs in a frame. Read-only .

Returns:

getText

java.lang.String getText()

Gets the plain text for a TextFrame.

Returns:

The text.

setText

void setText(java.lang.String value)
             throws DocumentEditException

Sets the plain text for a TextFrame.

Throws:

DocumentEditException

getTextStyle

TextStyle getTextStyle()

Gets text's style. Readonly .

Returns:

getMarginLeft

double getMarginLeft()

Gets the left margin (points) in a TextFrame. Read/write .

Returns:

setMarginLeft

void setMarginLeft(double value)
                   throws AppException

Sets the left margin (points) in a TextFrame. Read/write .

Throws:

AppException

getMarginRight

double getMarginRight()

Gets the right margin (points) in a TextFrame. Read/write .

Returns:

setMarginRight

void setMarginRight(double value)
                    throws AppException

Sets the right margin (points) in a TextFrame. Read/write .

Throws:

AppException

getMarginTop

double getMarginTop()

Gets the top margin (points) in a TextFrame. Read/write .

Returns:

setMarginTop

void setMarginTop(double value)
                  throws AppException

Sets the top margin (points) in a TextFrame. Read/write .

Throws:

AppException

getMarginBottom

double getMarginBottom()

Gets the bottom margin (points) in a TextFrame. Read/write .

Returns:

setMarginBottom

void setMarginBottom(double value)
                     throws AppException

Sets the bottom margin (points) in a TextFrame. Read/write .

Throws:

AppException

getTextRange

PortionEx getTextRange()

Text range of text frame.

Returns:

getWordWrap

boolean getWordWrap()

True if text is wrapped at TextFrame's margins. Read/write .

Returns:

setWordWrap

void setWordWrap(boolean value)

getAnchoringType

TextAnchorType getAnchoringType()

Gets vertical anchor text in a TextFrame. Read/write .

Returns:

setAnchoringType

void setAnchoringType(TextAnchorType value)

Sets vertical anchor text in a TextFrame. Read/write .

isCentered

boolean isCentered()

Indicates, whether text should be centered in box horizontally. Read/write .

Returns:

isCentered

void isCentered(boolean value)

getVerticalTextType

VerticalTextType getVerticalTextType()

Indicates text orientation. Read/write .

Returns:

setVerticalTextType

void setVerticalTextType(VerticalTextType value)

getAutofitType

TextAutofitType getAutofitType()

Gets text's autofit mode. Read/write .

Returns:

setAutofitType

void setAutofitType(TextAutofitType value)

Sets text's autofit mode. Read/write .

getSlide

ActiveSlide getSlide()

Gets the parent slide of a TextFrame. Read-only .

Returns:

Throws:

java.lang.Exception

getPresentation

Presentation getPresentation()

getParent

java.lang.Object getParent()

Reference to Parent object. Read-only.

Returns:

dispose

void dispose()

Dispose object and free resources.

getTextThreeD

FormatThreeD getTextThreeD()

Gets the FormatThreeD object that 3d effect properties for text.

Returns:

3d effect properties for text.

getRotationAngle

float getRotationAngle()

Gets the rotation angle of text frame .

Returns:

setRotationAngle

void setRotationAngle(float value)

Sets the rotation angle of text frame .