BodyRegion module

class BodyRegion.BodyRegion

Bases: DocumentBase, IBodyRegion

Represents a body region in a document.

property DeleteRevision: EditRevision

Gets the delete revision for this object. Note that this can be null if it does not have a delete revision.

Returns:

The delete revision for this object.

property InsertRevision: EditRevision

Gets the insert revision for this object. Note that this can be null if it does not have an insert revision.

Returns:

The insert revision for this object.

property IsDeleteRevision: bool

Gets a value indicating whether this item was deleted from the document.

Returns:

A boolean value indicating whether this item was deleted from the document.

property IsInsertRevision: bool

Gets a value indicating whether this item was inserted to the document.

Returns:

A boolean value indicating whether this item was inserted to the document.

property OwnerTextBody: Body

Gets the owner text body.

Returns:

The owner text body.

Replace

Replaces the given text with the specified replacement text in the body region.

Parameters:
  • given – The text to be replaced.

  • replace – The replacement text.

  • caseSensitive – A boolean value indicating whether the replacement should be case-sensitive.

  • wholeWord – A boolean value indicating whether the replacement should be done only for whole words.

Returns:

The number of replacements made.