StructureDocumentTag module

class StructureDocumentTag.StructureDocumentTag

Bases: BodyRegion, IBodyRegion, IStructureDocument, ICompositeObject

Represents a structured document tag.

property BreakCharacterFormat: CharacterFormat

Gets the character format for the break symbol. :return: The character format for the break symbol.

property ChildObjects: DocumentObjectCollection

Gets the child entities. :return: The child entities.

property DocumentObjectType: DocumentObjectType

Gets the type of the entity. :return: The type of the entity.

GetIndex(entity: IDocumentObject) → int

Gets the index of the specified entity. :param entity: The entity to get the index of. :return: The index of the specified entity.

Replace

Replaces the specified text in the structured document tag. :param given: The text to replace. :param replace: The replacement text. :param caseSensitive: A flag indicating whether the replacement should be case-sensitive. :param wholeWord: A flag indicating whether the replacement should be done for whole words only. :return: The number of replacements made.

property SDTContent: SDTContent

Gets the last known contents of the structured document tag. :return: The last known contents of the structured document tag.

property SDTProperties: SDTProperties

Gets the properties of the structured document tag. :return: The properties of the structured document tag.

UpdateDataBinding()

Updates the data binding of the structured document tag.