new_value property

FieldInfo.new_value property

Gets or sets an optional value that updates the property.

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

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

Examples

Shows how to work with INFO fields.

doc = aw.Document()
builder = aw.DocumentBuilder(doc)
# Set a value for the "comments" built-in property and then insert an INFO field to display that property's value.
doc.built_in_document_properties.comments = 'My comment'
field = builder.insert_field(aw.fields.FieldType.FIELD_INFO, True).as_field_info()
field.info_type = 'Comments'
field.update()
self.assertEqual(' INFO  Comments', field.get_field_code())
self.assertEqual('My comment', field.result)
builder.writeln()
# Setting a value for the field's "new_value" property and updating
# the field will also overwrite the corresponding built-in property with the new value.
field = builder.insert_field(aw.fields.FieldType.FIELD_INFO, True).as_field_info()
field.info_type = 'Comments'
field.new_value = 'New comment'
field.update()
self.assertEqual(' INFO  Comments "New comment"', field.get_field_code())
self.assertEqual('New comment', field.result)
self.assertEqual('New comment', doc.built_in_document_properties.comments)
doc.save(ARTIFACTS_DIR + 'Field.field_info.docx')

See Also

FieldInfo.info_type property