Interface: IRelativityFormsFieldHelper

Api for accessing and modifying fields

Methods

getHtmlElement()

getHtmlElement(identifier): 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): 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()

setCopyFromPreviousState(fieldIds, state): Promise<void>

Sets the indicators of fieldIds to the desired state

Parameters

• fieldIds: number[]

Array of fieldIds on the layout

• state: RwcCopyFromPreviousState

Desired state of fields

Returns

Promise<void>

---

setValue()

setValue(identifier, valueToSet): 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