Skip to content
Document Authoring DA  API Docs v2.1.0
npmGitHub

PageReferenceFieldDefinitionNEW

PageReferenceFieldDefinition:

{
  type: "pageReference";
  bookmark: string;
  hyperlink: boolean;
  relativePosition: boolean;
}

A page reference field (Word’s PAGEREF): the number of the page a bookmark is on.

Properties

Section titled “Properties”

type

Section titled “type”

type: "pageReference"

bookmark

Section titled “bookmark”

bookmark: string

The name of the bookmark referred to.

Section titled “hyperlink”

hyperlink: boolean

Whether the field’s text links to the bookmark (Word’s \h switch).

relativePosition

Section titled “relativePosition”

relativePosition: boolean

Whether the field shows where the bookmark is relative to the field: “above”, “below” or “on page N” (Word’s \p switch).