Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FieldScope

API to access information about and communicate with the current document field.

since

13.2

Hierarchy

  • FieldScope

Index

Methods

Methods

getCompareValue

  • getCompareValue(): Promise<string>
  • getCompareValue(...path: string[]): Promise<any>

  • Gets the field value to compare the current value to. Only valid when the document editor mode is DocumentEditorMode.Compare.

    since

    13.2

    Returns Promise<string>

    A promise that resolves with the compare value, or null when the document editor mode is not DocumentEditorMode.Compare.

  • Gets field values to compare the current values to. Only valid when the document editor mode is DocumentEditorMode.Compare.

    since

    14.3

    Parameters

    • Rest ...path: string[]

      The path is a string array pointing to the field or a nested subfield within the current document. For the multiple values fields, use zero-based indices to access specific values.

    Returns Promise<any>

    A promise that resolves with the field compare value, or null when the document editor mode is not DocumentEditorMode.Compare.

getValue

  • getValue(): Promise<string>
  • getValue(...path: string[]): Promise<any>

  • Gets the current field value.

    since

    13.2

    Returns Promise<string>

    A promise that resolves with the current field value.

  • Gets the current document field value.

    since

    14.3

    Parameters

    • Rest ...path: string[]

      The path is a string array pointing to the field or a nested subfield within the current document. For the multiple values fields, use zero-based indices to access specific values.

    Returns Promise<any>

    A promise that resolves with the field value.

setHeight

  • setHeight(height: "auto" | "initial" | number): Promise<void>

  • Set the height of the surrounding iframe.

    since

    13.2

    Parameters

    • height: "auto" | "initial" | number

      the number of pixels or 'auto' for automatic height detection or 'initial' for initial height from the config

    Returns Promise<void>

setValue

  • setValue(value: string): Promise<void>

  • Updates current field value.

    since

    13.2

    Parameters

    • value: string

      the new field value

    Returns Promise<void>