FieldAuthor class
FieldAuthor class
Implements the AUTHOR field. To learn more, visit the Working with Fields documentation article.
Remarks
Retrieves, and optionally sets, the document author’s name, as recorded in the Author property of the built-in document properties.
Inheritance: FieldAuthor → Field
Constructors
| Name | Description |
|---|---|
| FieldAuthor() | The default constructor. |
Properties
| Name | Description |
|---|---|
| author_name | Gets or sets the document author’s name. |
| display_result | Gets the text that represents the displayed field result. (Inherited from Field) |
| end | Gets the node that represents the field end. (Inherited from Field) |
| format | Gets a FieldFormat object that provides typed access to field’s formatting. (Inherited from Field) |
| is_dirty | Gets 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_locked | Gets or sets whether the field is locked (should not recalculate its result). (Inherited from Field) |
| locale_id | Gets or sets the LCID of the field. (Inherited from Field) |
| result | Gets or sets text that is between the field separator and field end. (Inherited from Field) |
| separator | Gets the node that represents the field separator. Can be None.(Inherited from Field) |
| start | Gets the node that represents the start of the field. (Inherited from Field) |
| type | Gets the Microsoft Word field type. (Inherited from Field) |
Methods
| Name | Description |
|---|---|
| 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 an AUTHOR field to display a document creator’s name.
doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
# AUTHOR fields source their results from the built-in document property called "Author".
# If we create and save a document in Microsoft Word,
# it will have our username in that property.
# However, if we create a document programmatically using Aspose.Words,
# the "Author" property, by default, will be an empty string.
self.assertEqual('', doc.built_in_document_properties.author)
# Set a backup author name for AUTHOR fields to use
# if the "Author" property contains an empty string.
doc.field_options.default_document_author = 'Joe Bloggs'
builder.write('This document was created by ')
field = builder.insert_field(field_type=aw.fields.FieldType.FIELD_AUTHOR, update_field=True).as_field_author()
field.update()
self.assertEqual(' AUTHOR ', field.get_field_code())
self.assertEqual('Joe Bloggs', field.result)
# Updating an AUTHOR field that contains a value
# will apply that value to the "Author" built-in property.
self.assertEqual('Joe Bloggs', doc.built_in_document_properties.author)
# Changing this property, then updating the AUTHOR field will apply this value to the field.
doc.built_in_document_properties.author = 'John Doe'
field.update()
self.assertEqual(' AUTHOR ', field.get_field_code())
self.assertEqual('John Doe', field.result)
# If we update an AUTHOR field after changing its "Name" property,
# then the field will display the new name and apply the new name to the built-in property.
field.author_name = 'Jane Doe'
field.update()
self.assertEqual(' AUTHOR "Jane Doe"', field.get_field_code())
self.assertEqual('Jane Doe', field.result)
# AUTHOR fields do not affect the DefaultDocumentAuthor property.
self.assertEqual('Jane Doe', doc.built_in_document_properties.author)
self.assertEqual('Joe Bloggs', doc.field_options.default_document_author)
doc.save(file_name=ARTIFACTS_DIR + 'Field.AUTHOR.docx')
See Also
- module aspose.words.fields
- class Field