This site is currently undergoing maintenance, so instances of "RelativityOne" may still be present. You may also experience 404 errors, search disruptions, and temporary style changes.

Last date modified: 2026-Sep-09

Interface: IRelativityFormsConvenienceAPI

The convienience api interface returned from RelativityForms setConvenienceAPI()

Properties

actionBar

actionBar: IRelativityFormsActionBarAPI

The actionBar api used to get the default actions

fieldHelper

fieldHelper: IRelativityFormsFieldHelper

Api helper for retrieving and modifying field values

layout

layout: IRelativityFormsLayoutHelper

Api helper for retrieving and modifying fields on layouts

navigation: IRelativityFormsNavigationAPI

The navigation api used to modify the form

relativityFormsPopup

relativityFormsPopup: IRelativityFormsPopupFactory

Methods for creating pop-up windows through the Relativity Forms API

Methods

getCurrentFormState()

getCurrentFormState(): IRelativityFormsState

Method to get the current state of Relativity Forms

Returns

IRelativityFormsState

Feedback