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, MasterHandoutSlide, NotesSlide, MasterSlide, MasterNotesSlide, LayoutSlide, BaseSlide


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)Highlight all matches of regular expression in text frame text using specified color.

Parameters:

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

highlightText

NameDescription
highlightText (String, Color)Highlight all matches of sample in text frame text using specified color.

Parameters:

NameTypeDescription
textStringText sample to highlight.
highlightColorColorHighlighting color.

highlightText

NameDescription
highlightText (String, Color, TextHighlightingOptions)Highlight all matches of sample in text frame text using specified color.

Parameters:

NameTypeDescription
textStringText sample to highlight.
highlightColorColorHighlighting color.
optionsTextHighlightingOptionsHighlighting options.

joinPortionsWithSameFormatting

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

setText

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