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

TextReferenceFieldDefinitionNEW

TextReferenceFieldDefinition:

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

A text reference field (Word’s REF): the text a bookmark covers.

Properties

Section titled “Properties”

type

Section titled “type”

type: "textReference"

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” or “below”, instead of its text (Word’s \p switch).