TextFrame class

TextFrame class

Represents a TextFrame.

The TextFrame type exposes the following members:

Properties

PropertyDescription
paragraphsReturns the list of all paragraphs in a frame.
Read-only IParagraphCollection.
textGets or sets the plain text for a TextFrame.
Read/write str.
text_frame_formatReturns the formatting object for this TextFrame object.
Read-only ITextFrameFormat.
hyperlink_queriesProvides easy access to contained hyperlinks.
Read-only IHyperlinkQueries.
slideReturns the parent slide of a TextFrame.
Read-only IBaseSlide.
presentationReturns the parent presentation of a TextFrame.
Read-only IPresentation.
parent_shapeReturns the parent shape or None if the parent object does not implement the IShape interface
Read-only IShape.
parent_cellReturns the parent cell or None if the parent object does not implement the ICell interface.
Read-only ICell.

Methods

MethodDescription
highlight_text(self, text, highlight_color)Highlights all matches of the sample text with the specified color.
highlight_text(self, text, highlight_color, options)Highlights all matches of the sample text with the specified color.
highlight_text(self, text, highlight_color, options, callback)Highlights all matches of the sample text with the specified color.
highlight_regex(self, regex, highlight_color, options)Highlights all matches of the regular expression with the specified color.
highlight_regex(self, regex, highlight_color)Highlights all matches of the regular expression with the specified color.
join_portions_with_same_formatting(self)Joins runs with same formatting in all paragraphs.
split_text_by_columns(self)Splits the text content of the ITextFrame into an array of strings,
where each element corresponds to a separate text column within the frame.
replace_text(self, old_text, new_text, options, callback)Replaces all occurrences of the specified text with another specified text.
replace_regex(self, regex, new_text)Replaces all matches of regular expression with specified string.

See Also