com.aspose.slides

Class TextFrame

java.lang.Object

com.aspose.slides.TextFrame

All Implemented Interfaces:

IPresentationComponent, ISlideComponent, ITextFrame

public final class TextFrame
extends java.lang.Object
implements ITextFrame

Represents a TextFrame.

Method Summary

Modifier and Type	Method and Description
IHyperlinkQueries	getHyperlinkQueries() Provides easy access to contained hyperlinks.
IParagraphCollection	getParagraphs() Returns the list of all paragraphs in a frame.
com.aspose.slides.IDOMObject	getParent_Immediate() Returns Parent_Immediate object.
IPresentation	getPresentation() Returns the parent presentation of a TextFrame.
IBaseSlide	getSlide() Returns the parent slide of a TextFrame.
java.lang.String	getText() Gets or sets the plain text for a TextFrame.
ITextFrameFormat	getTextFrameFormat() Returns the formatting object for this TextFrame object.
void	highlightRegex(java.lang.String regex, java.awt.Color highlightColor, ITextHighlightingOptions options) Highlight all matches of regular expression in text frame text using specified color.
void	highlightText(java.lang.String text, java.awt.Color highlightColor) Highlight all matches of sample in text frame text using specified color.
void	highlightText(java.lang.String text, java.awt.Color highlightColor, ITextHighlightingOptions options) Highlight all matches of sample in text frame text using specified color.
void	joinPortionsWithSameFormatting() Joins runs with same formatting in all paragraphs.
void	setText(java.lang.String value) Gets or sets the plain text for a TextFrame.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getParent_Immediate

public final com.aspose.slides.IDOMObject getParent_Immediate()

Returns Parent_Immediate object. Read-only IDOMObject.

getParagraphs

public final IParagraphCollection getParagraphs()

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

Specified by:

getParagraphs in interface ITextFrame

getText

public final java.lang.String getText()

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

Value: The text.

Specified by:

getText in interface ITextFrame

setText

public final void setText(java.lang.String value)

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

Value: The text.

Specified by:

setText in interface ITextFrame

getTextFrameFormat

public final ITextFrameFormat getTextFrameFormat()

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

Specified by:

getTextFrameFormat in interface ITextFrame

getHyperlinkQueries

public final IHyperlinkQueries getHyperlinkQueries()

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

Specified by:

getHyperlinkQueries in interface ITextFrame

joinPortionsWithSameFormatting

public final void joinPortionsWithSameFormatting()

Joins runs with same formatting in all paragraphs.

Specified by:

joinPortionsWithSameFormatting in interface ITextFrame

highlightText

public final void highlightText(java.lang.String text,
                                java.awt.Color highlightColor)

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

Specified by:

highlightText in interface ITextFrame

Parameters:

text - Text sample to highlight.

highlightColor - Highlighting color.

highlightText

public final void highlightText(java.lang.String text,
                                java.awt.Color highlightColor,
                                ITextHighlightingOptions options)

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

Specified by:

highlightText in interface ITextFrame

Parameters:

text - Text sample to highlight.

highlightColor - Highlighting color.

options - Highlighting options.

highlightRegex

public final void highlightRegex(java.lang.String regex,
                                 java.awt.Color highlightColor,
                                 ITextHighlightingOptions options)

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

Specified by:

highlightRegex in interface ITextFrame

Parameters:

regex - Text of regular expression to get text to highlight.

highlightColor - Highlighting color.

options - Highlighting options.

getSlide

public final IBaseSlide getSlide()

Returns the parent slide of a TextFrame. Read-only IBaseSlide.

Specified by:

getSlide in interface ISlideComponent

getPresentation

public final IPresentation getPresentation()

Returns the parent presentation of a TextFrame. Read-only IPresentation.

Specified by:

getPresentation in interface IPresentationComponent