Field module

class Field.Field

Bases: TextRange, IField

Represents a field in a document.

property Code: str

Gets or sets the field code. :returns: The field code.

property DocumentObjectType: DocumentObjectType

Gets the type of the document object. :returns: The type of the document object.

property End: FieldMark

Gets or sets the field end. :returns: The field mark, Type of FieldEnd.

property FieldText: str

Gets or sets the field display text information. :returns: The field display text information.

GetFieldCode() → str

Adds a paragraph at the end of the section. :return: The added paragraph.

property IsLocked: bool

Gets or sets the lock property of the field. If the field is locked, the field can’t be updated. :returns: A boolean value indicating whether the field is locked.

property Pattern: str

Returns or sets the field pattern. :returns: The field pattern.

property Separator: FieldMark

Gets or sets the field separator. :returns: The field separator.

property TextFormat: TextFormat

Gets or sets the regular text format. :returns: The regular text format.

property Type: FieldType

Returns or sets the field type. :returns: The field type.

Update()

Updates the result of the field. Can only be simpler field. Direct calls cannot update the NumPages field and Page field, etc.

property Value: str

Gets the field value. :returns: The field value.