ITextFrame

All Implemented Interfaces: com.aspose.slides.ISlideComponent

public interface ITextFrame extends ISlideComponent

Represents a TextFrame.

Methods

Method Description
getParagraphs() Returns the list of all paragraphs in a frame.
getText() Gets or sets the plain text for a TextFrame.
setText(String value) Gets or sets the plain text for a TextFrame.
getTextFrameFormat() Returns the formatting object for this TextFrame object.
getHyperlinkQueries() Provides easy access to contained hyperlinks.
joinPortionsWithSameFormatting() Joins runs with same formatting in all paragraphs.
highlightText(String text, Integer highlightColor) Highlight all matches of sample in text frame text using specified color.
highlightText(String text, Integer highlightColor, ITextHighlightingOptions options) Highlight all matches of sample in text frame text using specified color.
highlightRegex(String regex, Integer highlightColor, ITextHighlightingOptions options) Highlight all matches of regular expression in text frame text using specified color.

getParagraphs()

public abstract IParagraphCollection getParagraphs()

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

Returns: IParagraphCollection

getText()

public abstract String getText()

Gets or sets the plain text for a TextFrame. Read/write String.

Value: The text.

Returns: java.lang.String

setText(String value)

public abstract void setText(String value)

Gets or sets the plain text for a TextFrame. Read/write String.

Value: The text.

Parameters:

Parameter Type Description
value java.lang.String

getTextFrameFormat()

public abstract ITextFrameFormat getTextFrameFormat()

Returns the formatting object for this TextFrame object. Read-only ITextFrameFormat.

Returns: ITextFrameFormat

getHyperlinkQueries()

public abstract IHyperlinkQueries getHyperlinkQueries()

Provides easy access to contained hyperlinks. Read-only IHyperlinkQueries.

Returns: IHyperlinkQueries

joinPortionsWithSameFormatting()

public abstract void joinPortionsWithSameFormatting()

Joins runs with same formatting in all paragraphs.

highlightText(String text, Integer highlightColor)

public abstract void highlightText(String text, Integer highlightColor)

Highlight all matches of sample in text frame text using specified color.

Parameters:

Parameter Type Description
text java.lang.String Text sample to highlight.
highlightColor java.lang.Integer Highlighting color.

highlightText(String text, Integer highlightColor, ITextHighlightingOptions options)

public abstract void highlightText(String text, Integer highlightColor, ITextHighlightingOptions options)

Highlight all matches of sample in text frame text using specified color.

Parameters:

Parameter Type Description
text java.lang.String Text sample to highlight.
highlightColor java.lang.Integer Highlighting color.
options ITextHighlightingOptions Highlighting options.

highlightRegex(String regex, Integer highlightColor, ITextHighlightingOptions options)

public abstract void highlightRegex(String regex, Integer highlightColor, ITextHighlightingOptions options)

Highlight all matches of regular expression in text frame text using specified color.

Parameters:

Parameter Type Description
regex java.lang.String Text of regular expression to get text to highlight.
highlightColor java.lang.Integer Highlighting color.
options ITextHighlightingOptions Highlighting options.