text property

FieldSubject.text property

Gets or sets the text of the subject.

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

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

Examples

Shows how to use the SUBJECT field.

doc = aw.Document()

# Set a value for the document's "subject" built-in property.
doc.built_in_document_properties.subject = "My subject"

# Create a SUBJECT field to display the value of that built-in property.
builder = aw.DocumentBuilder(doc)
field = builder.insert_field(aw.fields.FieldType.FIELD_SUBJECT, True).as_field_subject()
field.update()

self.assertEqual(" SUBJECT ", field.get_field_code())
self.assertEqual("My subject", field.result)

# If we give the SUBJECT field's "text" property value and update it, the field will
# overwrite the current value of the "subject" built-in property with the value of its Text property,
# and then display the new value.
field.text = "My new subject"
field.update()

self.assertEqual(" SUBJECT  \"My new subject\"", field.get_field_code())
self.assertEqual("My new subject", field.result)

self.assertEqual("My new subject", doc.built_in_document_properties.subject)

doc.save(ARTIFACTS_DIR + "Field.field_subject.docx")

See Also

FieldSubject constructor