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

TextReferenceFieldDefinitionInputNEW

TextReferenceFieldDefinitionInput:

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

A text reference to add, as TextReferenceFieldDefinition with its switches optional.

Properties

Section titled “Properties”

type

Section titled “type”

type: "textReference"

bookmark

Section titled “bookmark”

bookmark: string

The name of the bookmark referred to. It must not be empty; the bookmark does not have to exist.

Section titled “hyperlink?”

optional hyperlink: boolean

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

relativePosition?

Section titled “relativePosition?”

optional relativePosition: boolean

Whether the field shows where the bookmark is relative to the field (Word’s \p switch). Defaults to false.