text property

FieldTitle.text property

Gets or sets the text of the title.

@property
def text(self) -> str:
    ...

@text.setter
def text(self, value: str):
    ...

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

FieldTitle constructor