ReferenceFieldOptionsNEW

ReferenceFieldOptions:

{
  bookmark: string;
  hyperlink?: boolean;
  relativePosition?: boolean;
}

The options of a page reference ('pageRef', Word’s PAGEREF field) or a text reference ('ref', Word’s REF field), for ActionCalls field.add and field.set-type.

Properties

bookmark

bookmark: string

The name of the bookmark the field refers to. An empty name is allowed: the field then shows Word’s “Error! No bookmark name given.” until a bookmark is set. A name that is not in the document shows “Error! Reference source not found.”.

---

hyperlink?

optional hyperlink: boolean

Whether the field links to the bookmark, Word’s \h switch. Defaults to false.

---

relativePosition?

optional relativePosition: boolean

Whether the field adds “above” or “below”, depending on where the bookmark is, Word’s \p switch. Defaults to false.