FieldNumPages class
FieldNumPages class
Implements the NUMPAGES field. To learn more, visit the Working with Fields documentation article.
Remarks
Retrieves the number of pages in the current document, as recorded in the Pages property of the built-in document properties.
Inheritance: FieldNumPages → Field
Constructors
| Name | Description |
|---|---|
| FieldNumPages() | 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) |
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 NUMCHARS, NUMWORDS, NUMPAGES and PAGE fields to track the size of our documents.
doc = aw.Document(file_name=MY_DIR + 'Paragraphs.docx')
builder = aw.DocumentBuilder(doc=doc)
builder.move_to_header_footer(aw.HeaderFooterType.FOOTER_PRIMARY)
builder.paragraph_format.alignment = aw.ParagraphAlignment.CENTER
# Below are three types of fields that we can use to track the size of our documents.
# 1 - Track the character count with a NUMCHARS field:
field_num_chars = builder.insert_field(field_type=aw.fields.FieldType.FIELD_NUM_CHARS, update_field=True).as_field_num_chars()
builder.writeln(' characters')
# 2 - Track the word count with a NUMWORDS field:
field_num_words = builder.insert_field(field_type=aw.fields.FieldType.FIELD_NUM_WORDS, update_field=True).as_field_num_words()
builder.writeln(' words')
# 3 - Use both PAGE and NUMPAGES fields to display what page the field is on,
# and the total number of pages in the document:
builder.paragraph_format.alignment = aw.ParagraphAlignment.RIGHT
builder.write('Page ')
field_page = builder.insert_field(field_type=aw.fields.FieldType.FIELD_PAGE, update_field=True).as_field_page()
builder.write(' of ')
field_num_pages = builder.insert_field(field_type=aw.fields.FieldType.FIELD_NUM_PAGES, update_field=True).as_field_num_pages()
self.assertEqual(' NUMCHARS ', field_num_chars.get_field_code())
self.assertEqual(' NUMWORDS ', field_num_words.get_field_code())
self.assertEqual(' NUMPAGES ', field_num_pages.get_field_code())
self.assertEqual(' PAGE ', field_page.get_field_code())
# These fields will not maintain accurate values in real time
# while we edit the document programmatically using Aspose.Words, or in Microsoft Word.
# We need to update them every we need to see an up-to-date value.
doc.update_fields()
doc.save(file_name=ARTIFACTS_DIR + 'Field.NUMCHARS.NUMWORDS.NUMPAGES.PAGE.docx')
See Also
- module aspose.words.fields
- class Field