TextFrame

TextFrame class

Represents a TextFrame.

getHyperlinkQueries

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

Returns: HyperlinkQueries

---

getParagraphs

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

Returns: ParagraphCollection

---

getParentCell

Name	Description
getParentCell()	Returns the parent cell or null if the parent object does not implement the ICell interface. Read-only ICell.

Returns: Cell

---

getParentShape

Name	Description
getParentShape()	Returns the parent shape or null if the parent object does not implement the IShape interface Read-only IShape.

Returns: PictureFrame, SmartArt, OleObjectFrame, AutoShape, SummaryZoomSection, Connector, Ink, VideoFrame, LegacyDiagram, SmartArtShape, ZoomFrame, GeometryShape, SummaryZoomFrame, GraphicalObject, InkActions, SectionZoomFrame, Chart, AudioFrame, Shape, ZoomObject, GroupShape, Table

---

getPresentation

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

Returns: Presentation

---

getSlide

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

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

---

getText

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

Returns: String

---

getTextFrameFormat

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

Returns: TextFrameFormat

---

highlightRegex

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

Parameters:

Name	Type	Description
regex	String	Text of regular expression to get text to highlight.
highlightColor	Color	The color to highlight the text.
options	TextHighlightingOptions	Highlighting options.

---

highlightRegex

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

Parameters:

Name	Type	Description
regex	Pattern	The regular expression java.util.regex.Pattern to get strings to highlight.
highlightColor	Color	The color to highlight the text.
callback	IFindResultCallback	The callback object for receiving search results IFindResultCallback.

---

highlightText

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

Parameters:

Name	Type	Description
text	String	Text sample to highlight.
highlightColor	Color	The color to highlight the text.

---

highlightText

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

Parameters:

Name	Type	Description
text	String	The text to highlight.
highlightColor	Color	The color to highlight the text.
options	TextHighlightingOptions	Highlighting options.

---

highlightText

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

Parameters:

Name	Type	Description
text	String	The text to highlight.
highlightColor	Color	The color to highlight the text.
options	TextSearchOptions	Text search options ITextSearchOptions.
callback	IFindResultCallback	The callback object for receiving search results IFindResultCallback.

---

joinPortionsWithSameFormatting

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

---

replaceRegex

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

Parameters:

Name	Type	Description
regex	Pattern	The regular expression java.util.regex.Pattern to get strings to be replaced.
newText	String	The string to replace all occurrences of strings to be replaced.
callback	IFindResultCallback	Callback object for saving replacement operation result IFindResultCallback.

---

replaceText

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

Parameters:

Name	Type	Description
oldText	String	The string to be replaced.
newText	String	The string to replace all occurrences of oldText.
options	TextSearchOptions	Text search options ITextSearchOptions.
callback	IFindResultCallback	Callback object for saving replacement operation result IFindResultCallback.

---

setText

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

---

splitTextByColumns

Name	Description
splitTextByColumns()	Splits the text content of the ITextFrame into an array of strings, where each element corresponds to a separate text column within the frame.

Returns: String

---