TextFrame

TextFrame class

Represents a TextFrame.

getHyperlinkQueries

NameDescription
getHyperlinkQueries ()Provides easy access to contained hyperlinks. Read-only IHyperlinkQueries.

Returns: HyperlinkQueries


getParagraphs

NameDescription
getParagraphs ()Returns the list of all paragraphs in a frame. Read-only IParagraphCollection.

Returns: ParagraphCollection


getPresentation

NameDescription
getPresentation ()Returns the parent presentation of a TextFrame. Read-only IPresentation.

Returns: Presentation


getSlide

NameDescription
getSlide ()Returns the parent slide of a TextFrame. Read-only IBaseSlide.

Returns: Slide, MasterSlide, LayoutSlide, NotesSlide, BaseSlide, MasterNotesSlide, MasterHandoutSlide


getText

NameDescription
getText ()Gets or sets the plain text for a TextFrame. Read/write String. Value: The text.

Returns: String


getTextFrameFormat

NameDescription
getTextFrameFormat ()Returns the formatting object for this TextFrame object. Read-only ITextFrameFormat.

Returns: TextFrameFormat


highlightRegex

NameDescription
highlightRegex (String, Color, TextHighlightingOptions)Highlights all matches of the regular expression with the specified color.

Parameters:

NameTypeDescription
regexStringText of regular expression to get text to highlight.
highlightColorColorThe color to highlight the text.
optionsTextHighlightingOptionsHighlighting options.

highlightRegex

NameDescription
highlightRegex (Pattern, Color, IFindResultCallback)Highlights all matches of the regular expression with the specified color.

Parameters:

NameTypeDescription
regexPatternThe regular expression java.util.regex.Pattern to get strings to highlight.
highlightColorColorThe color to highlight the text.
callbackIFindResultCallbackThe callback object for receiving search results IFindResultCallback.

highlightText

NameDescription
highlightText (String, Color)Highlights all matches of the sample text with the specified color.

Parameters:

NameTypeDescription
textStringText sample to highlight.
highlightColorColorThe color to highlight the text.

highlightText

NameDescription
highlightText (String, Color, TextHighlightingOptions)Highlights all matches of the sample text with the specified color.

Parameters:

NameTypeDescription
textStringThe text to highlight.
highlightColorColorThe color to highlight the text.
optionsTextHighlightingOptionsHighlighting options.

highlightText

NameDescription
highlightText (String, Color, TextSearchOptions, IFindResultCallback)Highlights all matches of the sample text with the specified color.

Parameters:

NameTypeDescription
textStringThe text to highlight.
highlightColorColorThe color to highlight the text.
optionsTextSearchOptionsText search options ITextSearchOptions.
callbackIFindResultCallbackThe callback object for receiving search results IFindResultCallback.

joinPortionsWithSameFormatting

NameDescription
joinPortionsWithSameFormatting ()Joins runs with same formatting in all paragraphs.

replaceRegex

NameDescription
replaceRegex (Pattern, String, IFindResultCallback)Replaces all matches of regular expression with specified string.

Parameters:

NameTypeDescription
regexPatternThe regular expression java.util.regex.Pattern to get strings to be replaced.
newTextStringThe string to replace all occurrences of strings to be replaced.
callbackIFindResultCallbackCallback object for saving replacement operation result IFindResultCallback.

replaceText

NameDescription
replaceText (String, String, TextSearchOptions, IFindResultCallback)Replaces all occurrences of the specified text with another specified text.

Parameters:

NameTypeDescription
oldTextStringThe string to be replaced.
newTextStringThe string to replace all occurrences of oldText.
optionsTextSearchOptionsText search options ITextSearchOptions.
callbackIFindResultCallbackCallback object for saving replacement operation result IFindResultCallback.

setText

NameDescription
setText (String)Gets or sets the plain text for a TextFrame. Read/write String. Value: The text.