Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICodingCard

Class for the coding card

Hierarchy

Index

Properties

Methods

Properties

buttons

buttons: IRelativityFormsEnvelopeCustomButtonSettings[]

Returns all the registered buttons on the layout

returns

Optional cardActivated

cardActivated: function

Called after the card is activated in a dock.

Type declaration

Optional cardCanDeactivate

cardCanDeactivate: function

Called before the card deactivates to check if it is safe to do so

Type declaration

Optional cardDeactivated

cardDeactivated: function

Called after the card is deactivated in a dock.

Type declaration

Optional cardError

cardError: function

Called whenever an error occurs while managing the card

Type declaration

Optional cardLoadState

cardLoadState: function

Called to restore the state of the card

Type declaration

Optional cardLoaded

cardLoaded: function

Called after the card content has loaded

Type declaration

Optional cardMaximized

cardMaximized: function

Called when the card is maximized

Type declaration

Optional cardResized

cardResized: function

Called when the card is resized

Type declaration

Optional cardRestored

cardRestored: function

Called when the card is no longer maximized

Type declaration

Optional cardSaveState

cardSaveState: function

Called to save the state of the card

Type declaration

Optional cardUnloaded

cardUnloaded: function

Called before the card content is unloaded

Type declaration

isEditMode

isEditMode: boolean

True if card is in Edit mode, false otherwise.

type

{boolean}

isLoaded

isLoaded: boolean

True if card is loaded, false otherwise.

type

{boolean}

Methods

addButton

applyCopyFromPreviousAsync

  • applyCopyFromPreviousAsync(): Promise<void>

  • Applies Copied Values to Coding Card Fields. Assumed SaveAndNextAsync is called to save fields.

    Returns Promise<void>

cancelAsync

  • cancelAsync(): Promise<void>

  • Updates the Relativity Form to be in view mode

    Returns Promise<void>

editAsync

  • editAsync(): Promise<void>

  • Updates the Relativity Form to be in edit mode

    Returns Promise<void>

getConvenienceAPI

getRelativityFormsEnvelope

removeButton

  • removeButton(buttonId: string): void

  • Removes a button from the layout toolbar

    Parameters

    • buttonId: string

    Returns void

saveAndBackAsync

  • saveAndBackAsync(): Promise<boolean>

  • Saves the current state of the Relativity Forms fields and returns the user to the document list

    Returns Promise<boolean>

    Returns whether the save and navigation was successful

saveAndNextAsync

  • saveAndNextAsync(...rest: any[]): Promise<boolean>

  • Saves the current state of the Relativity Forms fields and navigates to the next document in the queue

    Parameters

    • Rest ...rest: any[]

    Returns Promise<boolean>

    Returns whether the save and navigation was successful

saveAsync

  • saveAsync(stayInEditMode?: boolean): Promise<boolean>

  • Saves the current state of the Relativity Forms fields

    Parameters

    • Optional stayInEditMode: boolean

      (optional) Whether to stay in edit mode after Relativity Forms save. Defaults to false

    Returns Promise<boolean>

    Returns whether the save was successful