Class formAction

Index

Methods

addField addGroup addSetting onFormStart onLoad setAction setChangeListener setDisplayName

Methods

addField

addField(
    tag?: string,
    min?: number,
    max?: number,
    actions?: string[],
    display?: { helpText: string; name: string },
): formAction
Add a field (input/output) for this form action
Parameters
- tag: string = ''
- Optionalmin: number = 0
  default 0
- Optionalmax: number = 0
  default 0 (unlimited)
- Optionalactions: string[]
  name of actions
- Optionaldisplay: { helpText: string; name: string }
  default {}
  - helpText: string
    default ''
  - name: string
    defaults to tag
Returns formAction

addGroup

addGroup(
    tag?: string,
    min?: number,
    max?: number,
    display?: { helpText: string; name: string },
): formAction
Add a group (input/output) for this form action
Parameters
- tag: string = ''
- Optionalmin: number = 0
  default 0
- Optionalmax: number = 0
  default 0 (unlimited)
- Optionaldisplay: { helpText: string; name: string }
  default {}
  - helpText: string
    default ''
  - name: string
    defaults to tag
Returns formAction

addSetting

addSetting(tag: string, type: string, required: boolean): formAction
Add settings for this form action
Parameters
- tag: string
- type: string
- required: boolean
Returns formAction

onFormStart

onFormStart(formStart: () => void): formAction
Set the function to execute when the form is started
Parameters
- formStart: () => void
Returns formAction

onLoad

onLoad(load: () => void): formAction
Set the function to execute when the form is loaded
Parameters
- load: () => void
Returns formAction

setAction

setAction(
    actionName: string,
    action: (fields: any, groups: any, settings: any, form: any) => void,
    options: { isDefault: boolean },
): formAction
Set the default action for this form action
Parameters
- actionName: string
- action: (fields: any, groups: any, settings: any, form: any) => void
- options: { isDefault: boolean }
Returns formAction

setChangeListener

setChangeListener(fieldNames: string | string[], actionName: string): formAction
Set the fields that trigger the action
Parameters
- fieldNames: string | string[]
- actionName: string
Returns formAction

setDisplayName

setDisplayName(displayName: string): formAction
Set the display name for this form action
Parameters
- displayName: string
Returns formAction