FieldUserName class
FieldUserName class
Implements the USERNAME field. To learn more, visit the Working with Fields documentation article.
Remarks
Retrieves the current user’s name.
Inheritance: FieldUserName → Field
Constructors
| Name | Description |
|---|---|
| FieldUserName() | The default constructor. |
Properties
| Name | Description |
|---|---|
| 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) |
| user_name | Gest or sets the current user’s name. |
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 the USERNAME field.
doc = aw.Document()
# Create a UserInformation object and set it as the source of user information for any fields that we create.
user_information = aw.fields.UserInformation()
user_information.name = "John Doe"
doc.field_options.current_user = user_information
builder = aw.DocumentBuilder(doc)
# Create a USERNAME field to display the current user's name,
# taken from the UserInformation object we created above.
field_user_name = builder.insert_field(aw.fields.FieldType.FIELD_USER_NAME, True).as_field_user_name()
self.assertEqual(user_information.name, field_user_name.result)
self.assertEqual(" USERNAME ", field_user_name.get_field_code())
self.assertEqual("John Doe", field_user_name.result)
# We can set this property to get our field to override the value currently stored in the UserInformation object.
field_user_name.user_name = "Jane Doe"
field_user_name.update()
self.assertEqual(" USERNAME \"Jane Doe\"", field_user_name.get_field_code())
self.assertEqual("Jane Doe", field_user_name.result)
# This does not affect the value in the UserInformation object.
self.assertEqual("John Doe", doc.field_options.current_user.name)
doc.update_fields()
doc.save(ARTIFACTS_DIR + "Field.field_user_name.docx")
See Also
- module aspose.words.fields
- class Field