FieldTitle class

FieldTitle class

Implements the TITLE field. To learn more, visit the Working with Fields documentation article.

Remarks

Retrieves, and optionally sets, the document’s title, as recorded in the Title property of the built-in document properties.

Inheritance: FieldTitleField

Constructors

NameDescription
FieldTitle()The default constructor.

Properties

NameDescription
display_resultGets the text that represents the displayed field result.
(Inherited from Field)
endGets the node that represents the field end.
(Inherited from Field)
formatGets a FieldFormat object that provides typed access to field’s formatting.
(Inherited from Field)
is_dirtyGets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
(Inherited from Field)
is_lockedGets or sets whether the field is locked (should not recalculate its result).
(Inherited from Field)
locale_idGets or sets the LCID of the field.
(Inherited from Field)
resultGets or sets text that is between the field separator and field end.
(Inherited from Field)
separatorGets the node that represents the field separator. Can be None.
(Inherited from Field)
startGets the node that represents the start of the field.
(Inherited from Field)
textGets or sets the text of the title.
typeGets the Microsoft Word field type.
(Inherited from Field)

Methods

NameDescription
get_field_code()Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.
(Inherited from Field)
get_field_code(include_child_field_codes)Returns text between field start and field separator (or field end if there is no separator).
(Inherited from Field)
remove()Removes the field from the document. Returns a node right after the field. If the field’s end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns None.
(Inherited from Field)
unlink()Performs the field unlink.
(Inherited from Field)
update()Performs the field update. Throws if the field is being updated already.
(Inherited from Field)
update(ignore_merge_format)Performs a field update. Throws if the field is being updated already.
(Inherited from Field)

Examples

Shows how to use the TITLE field.

doc = aw.Document()

# Set a value for the "title" built-in document property.
doc.built_in_document_properties.title = "My Title"

# We can use the TITLE field to display the value of this property in the document.
builder = aw.DocumentBuilder(doc)
field = builder.insert_field(aw.fields.FieldType.FIELD_TITLE, False).as_field_title()
field.update()

self.assertEqual(" TITLE ", field.get_field_code())
self.assertEqual("My Title", field.result)

# Setting a value for the field's "text" property,
# and then updating the field will also overwrite the corresponding built-in property with the new value.
builder.writeln()
field = builder.insert_field(aw.fields.FieldType.FIELD_TITLE, False).as_field_title()
field.text = "My New Title"
field.update()

self.assertEqual(" TITLE  \"My New Title\"", field.get_field_code())
self.assertEqual("My New Title", field.result)
self.assertEqual("My New Title", doc.built_in_document_properties.title)

doc.update_fields()
doc.save(ARTIFACTS_DIR + "Field.field_title.docx")

See Also