StructureDocumentTagInline module

class StructureDocumentTagInline.StructureDocumentTagInline

Bases: ParagraphBase, IStructureDocument, ICompositeObject

Represents a structured document tag around one or more inline-level structures.

BackupChildObjects()

Backs up the child entities.

property BreakCharacterFormat: CharacterFormat

Gets the character format for the break symbol.

Returns:

The character format for the break symbol.

Return type:

CharacterFormat

property ChildObjects: DocumentObjectCollection

Gets the child entities.

Returns:

The child entities.

Return type:

DocumentObjectCollection

property DocumentObjectType: DocumentObjectType

Gets the type of the entity.

Returns:

The type of the entity.

Return type:

DocumentObjectType

MakeChanges(acceptChanges: bool)

Makes changes to the structured document tag.

Parameters:

acceptChanges (bool) – A value indicating whether to accept the changes.

RevertChildObjects()

Reverts the child entities.

property SDTContent: SDTInlineContent

Gets the last known contents of the structured document tag.

Returns:

The last known contents of the structured document tag.

Return type:

SDTInlineContent

property SDTProperties: SDTProperties

Gets the properties of the structured document tag.

Returns:

The properties of the structured document tag.

Return type:

SDTProperties

UpdateDataBinding()

Updates the data binding of the structured document tag.