IParagraph module

class IParagraph.IParagraph

Bases: IBodyRegion, IStyleHolder, ICompositeObject

Represents a paragraph in a document.

abstract AppendBookmarkEnd(name: str) → BookmarkEnd: Appends a bookmark end with the specified name to the paragraph and returns the appended bookmark end.

abstract AppendBookmarkStart(name: str) → BookmarkStart: Appends a bookmark start with the specified name to the paragraph and returns the appended bookmark start.

abstract AppendBreak(breakType: BreakType) → Break: Appends a break with the specified type to the paragraph and returns the appended break.

AppendCheckBox: Appends a checkbox form field to the paragraph and returns the appended checkbox form field.

abstract AppendComment(text: str) → Comment: Appends a comment with the specified text to the paragraph and returns the appended comment.

AppendDropDownFormField: Appends a dropdown form field to the paragraph and returns the appended dropdown form field.

abstract AppendField(fieldName: str, fieldType: FieldType) → Field: Appends a field with the specified name and type to the paragraph and returns the appended field.

abstract AppendFootnote(type: FootnoteType) → Footnote: Appends a footnote with the specified type to the paragraph and returns the appended footnote.

abstract AppendHTML(html: str): Appends the specified HTML content to the paragraph.

AppendHyperlink: Appends a hyperlink with the specified link, display text, and type to the paragraph and returns the appended hyperlink field.

AppendOleObject: Appends an OLE object with the specified stream, picture, and type to the paragraph and returns the appended OLE object.

abstract AppendSymbol(characterCode: int) → Symbol: Appends a symbol with the specified character code to the paragraph and returns the appended symbol.

abstract AppendTOC(lowerHeadingLevel: int, upperHeadingLevel: int) → TableOfContent: Appends a table of contents with the specified lower and upper heading levels to the paragraph and returns the appended table of contents.

abstract AppendText(text: str) → TextRange: Appends the specified text to the paragraph and returns the appended text range.

abstract AppendTextBox(width: float, height: float) → TextBox: Appends a text box with the specified width and height to the paragraph and returns the appended text box.

AppendTextFormField: Appends a text form field with the specified default text to the paragraph and returns the appended text form field.

abstract property BreakCharacterFormat: CharacterFormat: Gets the character formatting settings for the break character in the paragraph.

abstract property Format: ParagraphFormat: Gets the formatting settings for the paragraph.

abstract GetStyle() → ParagraphStyle: Gets the style applied to the paragraph.

abstract property IsEndOfDocument: bool: Gets a value indicating whether the paragraph is at the end of the document.

abstract property IsEndOfSection: bool: Gets a value indicating whether the paragraph is at the end of a section.

abstract property IsInCell: bool: Gets a value indicating whether the paragraph is inside a table cell.

abstract property Items: ParagraphItemCollection: Gets the collection of paragraph items in the paragraph.

abstract property ListFormat: ListFormat: Gets the list formatting settings for the paragraph.

abstract RemoveAbsPosition(): Removes the absolute position of the paragraph.

abstract Replace(given: str, textSelection: TextSelection, caseSensitive: bool, wholeWord: bool) → int: Replaces the specified text in the paragraph with the specified replacement text and returns the number of replacements made.

abstract property Text: str: Gets or sets the text content of the paragraph.

abstract get_Item(index: int) → ParagraphBase: Gets the paragraph item at the specified index.