FieldAutoNum class
FieldAutoNum class
Implements the AUTONUM field. To learn more, visit the Working with Fields documentation article.
Remarks
Inserts an automatic number.
Inheritance: FieldAutoNum → Field
Constructors
| Name | Description |
|---|---|
| FieldAutoNum() | 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) |
| separator_character | Gets or sets the separator character to be used. |
| 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 number paragraphs using autonum fields.
doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
# Each AUTONUM field displays the current value of a running count of AUTONUM fields,
# allowing us to automatically number items like a numbered list.
# This field will display a number "1.".
field = builder.insert_field(field_type=aw.fields.FieldType.FIELD_AUTO_NUM, update_field=True).as_field_auto_num()
builder.writeln('\tParagraph 1.')
self.assertEqual(' AUTONUM ', field.get_field_code())
field = builder.insert_field(field_type=aw.fields.FieldType.FIELD_AUTO_NUM, update_field=True).as_field_auto_num()
builder.writeln('\tParagraph 2.')
# The separator character, which appears in the field result immediately after the number,is a full stop by default.
# If we leave this property null, our second AUTONUM field will display "2." in the document.
self.assertIsNone(field.separator_character)
# We can set this property to apply the first character of its string as the new separator character.
# In this case, our AUTONUM field will now display "2:".
field.separator_character = ':'
self.assertEqual(' AUTONUM \\s :', field.get_field_code())
doc.save(file_name=ARTIFACTS_DIR + 'Field.AUTONUM.docx')
See Also
- module aspose.words.fields
- class Field