FieldPageRef class

FieldPageRef class

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

Remarks

Inserts the number of the page containing the specified bookmark for a cross-reference.

Inheritance: FieldPageRef → Field

Constructors

NameDescription
FieldPageRef()The default constructor.

Properties

NameDescription
bookmark_nameGets or sets the name of the bookmark.
display_resultGets the text that represents the displayed field result.
(Inherited from Field)
endGets the node that represents the field end.
(Inherited from Field)
formatGets a FieldFormat object that provides typed access to field’s formatting.
(Inherited from Field)
insert_hyperlinkGets or sets whether to insert a hyperlink to the bookmarked paragraph.
insert_relative_positionGets or sets whether to insert a relative position of the bookmarked paragraph.
is_dirtyGets 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_lockedGets or sets whether the field is locked (should not recalculate its result).
(Inherited from Field)
locale_idGets or sets the LCID of the field.
(Inherited from Field)
resultGets or sets text that is between the field separator and field end.
(Inherited from Field)
separatorGets the node that represents the field separator. Can be None.
(Inherited from Field)
startGets the node that represents the start of the field.
(Inherited from Field)
typeGets the Microsoft Word field type.
(Inherited from Field)

Methods

NameDescription
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 to insert PAGEREF fields to display the relative location of bookmarks.

def field_page_ref():
    doc = aw.Document()
    builder = aw.DocumentBuilder(doc)
    insert_and_name_bookmark(builder, 'MyBookmark1')
    # Insert a PAGEREF field that displays what page a bookmark is on.
    # Set the InsertHyperlink flag to make the field also function as a clickable link to the bookmark.
    self.assertEqual(' PAGEREF  MyBookmark3 \\h', insert_field_page_ref(builder, 'MyBookmark3', True, False, 'Hyperlink to Bookmark3, on page: ').get_field_code())
    # We can use the \p flag to get the PAGEREF field to display
    # the bookmark's position relative to the position of the field.
    # Bookmark1 is on the same page and above this field, so this field's displayed result will be "above".
    self.assertEqual(' PAGEREF  MyBookmark1 \\h \\p', insert_field_page_ref(builder, 'MyBookmark1', True, True, 'Bookmark1 is ').get_field_code())
    # Bookmark2 will be on the same page and below this field, so this field's displayed result will be "below".
    self.assertEqual(' PAGEREF  MyBookmark2 \\h \\p', insert_field_page_ref(builder, 'MyBookmark2', True, True, 'Bookmark2 is ').get_field_code())
    # Bookmark3 will be on a different page, so the field will display "on page 2".
    self.assertEqual(' PAGEREF  MyBookmark3 \\h \\p', insert_field_page_ref(builder, 'MyBookmark3', True, True, 'Bookmark3 is ').get_field_code())
    insert_and_name_bookmark(builder, 'MyBookmark2')
    builder.insert_break(aw.BreakType.PAGE_BREAK)
    insert_and_name_bookmark(builder, 'MyBookmark3')
    doc.update_page_layout()
    doc.update_fields()
    doc.save(ARTIFACTS_DIR + 'Field.field_page_ref.docx')

def insert_field_page_ref(builder: aw.DocumentBuilder, bookmark_name: str, insert_hyperlink: bool, insert_relative_position: bool, text_before: str) -> aw.fields.FieldPageRef:
    """Uses a document builder to insert a PAGEREF field and sets its properties."""
    builder.write(text_before)
    field = builder.insert_field(aw.fields.FieldType.FIELD_PAGE_REF, True).as_field_page_ref()
    field.bookmark_name = bookmark_name
    field.insert_hyperlink = insert_hyperlink
    field.insert_relative_position = insert_relative_position
    builder.writeln()
    return field

def insert_and_name_bookmark(builder: aw.DocumentBuilder, bookmark_name: str):
    """Uses a document builder to insert a named bookmark."""
    builder.start_bookmark(bookmark_name)
    builder.writeln(f'Contents of bookmark "{bookmark_name}".')
    builder.end_bookmark(bookmark_name)

See Also

FieldPage class FieldPrint class