Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IRelativityFormsFieldHelper

Api for accessing and modifying fields

Hierarchy

  • IRelativityFormsFieldHelper

Index

Methods

Methods

getHtmlElement

  • getHtmlElement(identifier: string | number | object): Promise<IRwcHtmlElement>

  • Retrieves the HTML element associated with a field.

    Parameters

    • identifier: string | number | object

      Identifier to look up field. Normally field name or artifact id

    Returns Promise<IRwcHtmlElement>

    It returns a promise that resolves to the HTML element of the field and resolves to null if the get operation does not succeed.

getValue

  • getValue(identifier: string | number | object): Promise<any>

  • Retrieves field value by identifier

    Parameters

    • identifier: string | number | object

      Identifier to look up field. Normally field name or artifact id

    Returns Promise<any>

    Object representing value of field. Different for each field type

setCopyFromPreviousState

  • Sets the indicators of fieldIds to the desired state

    Parameters

    Returns Promise<void>

setValue

  • setValue(identifier: string | number | object, valueToSet: any): Promise<any>

  • Sets the value of a given field.

    Parameters

    • identifier: string | number | object

      Identifier to look up field. Normally field name or artifact id

    • valueToSet: any

      Value to set field to. Different for each field type

    Returns Promise<any>

    valueToSet if set properly, null if set does not succeed