FieldAutoNumLgl class

FieldAutoNumLgl class

Implements the AUTONUMLGL field. To learn more, visit the Working with Fields documentation article.

Remarks

Inserts an automatic number in legal format.

Inheritance: FieldAutoNumLgl → Field

Constructors

Name	Description
FieldAutoNumLgl()	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)
remove_trailing_period	Gets or sets whether to display the number without a trailing period.
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 organize a document using AUTONUMLGL fields.

def test_field_auto_num_lgl(self):

    doc = aw.Document()
    builder = aw.DocumentBuilder(doc)

    filler_text = (
        "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. " +
        "\nUt enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. ")

    # AUTONUMLGL fields display a number that increments at each AUTONUMLGL field within its current heading level.
    # These fields maintain a separate count for each heading level,
    # and each field also displays the AUTONUMLGL field counts for all heading levels below its own.
    # Changing the count for any heading level resets the counts for all levels above that level to 1.
    # This allows us to organize our document in the form of an outline list.
    # This is the first AUTONUMLGL field at a heading level of 1, displaying "1." in the document.
    ExField._insert_numbered_clause(builder, "\tHeading 1", filler_text, aw.StyleIdentifier.HEADING1)

    # This is the second AUTONUMLGL field at a heading level of 1, so it will display "2.".
    ExField._insert_numbered_clause(builder, "\tHeading 2", filler_text, aw.StyleIdentifier.HEADING1)

    # This is the first AUTONUMLGL field at a heading level of 2,
    # and the AUTONUMLGL count for the heading level below it is "2", so it will display "2.1.".
    ExField._insert_numbered_clause(builder, "\tHeading 3", filler_text, aw.StyleIdentifier.HEADING2)

    # This is the first AUTONUMLGL field at a heading level of 3.
    # Working in the same way as the field above, it will display "2.1.1.".
    ExField._insert_numbered_clause(builder, "\tHeading 4", filler_text, aw.StyleIdentifier.HEADING3)

    # This field is at a heading level of 2, and its respective AUTONUMLGL count is at 2, so the field will display "2.2.".
    ExField._insert_numbered_clause(builder, "\tHeading 5", filler_text, aw.StyleIdentifier.HEADING2)

    # Incrementing the AUTONUMLGL count for a heading level below this one
    # has reset the count for this level so that this field will display "2.2.1.".
    ExField._insert_numbered_clause(builder, "\tHeading 6", filler_text, aw.StyleIdentifier.HEADING3)

    for field in doc.range.fields:
        if field.type == aw.fields.FieldType.FIELD_AUTO_NUM_LEGAL:
            field = field.as_field_auto_num_lgl()
            # 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 last AUTONUMLGL field will display "2.2.1." in the document.
            self.assertIsNone(field.separator_character)

            # Setting a custom separator character and removing the trailing period
            # will change that field's appearance from "2.2.1." to "2:2:1".
            # We will apply this to all the fields that we have created.
            field.separator_character = ":"
            field.remove_trailing_period = True
            self.assertEqual(" AUTONUMLGL  \\s : \\e", field.get_field_code())

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

@staticmethod
def _insert_numbered_clause(builder: aw.DocumentBuilder, heading: str, contents: str, heading_style: aw.StyleIdentifier):
    """Uses a document builder to insert a clause numbered by an AUTONUMLGL field."""

    builder.insert_field(aw.fields.FieldType.FIELD_AUTO_NUM_LEGAL, True)
    builder.current_paragraph.paragraph_format.style_identifier = heading_style
    builder.writeln(heading)

    # This text will belong to the auto num legal field above it.
    # It will collapse when we click the arrow next to the corresponding AUTONUMLGL field in Microsoft Word.
    builder.current_paragraph.paragraph_format.style_identifier = aw.StyleIdentifier.BODY_TEXT
    builder.writeln(contents)

See Also

• module aspose.words.fields
• class Field