Class FormDefinition

Static properties and methods related to the form definition structure.

Index

Constructors

Methods

get getAttachmentBlob getAttachmentPath getAttachmentUrl getConditionTable getLookUpTable getProxyHost setApproveButtonLabel setApproveDialogMessage setApproveDialogTitle

Constructors

constructor

new FormDefinition(): FormDefinition
Returns FormDefinition

Methods

`Static`get

get(): IFormDefinition
Get the form definition (IFormDefinition) of the current Form

Returns IFormDefinition

`Static`getAttachmentBlob

getAttachmentBlob(filename: string): Promise<Blob>
Takes the name of a file from the formdefiniton and returns a Promise with the actual file blob
Parameters
- filename: string
Returns Promise<Blob>

`Static`getAttachmentPath

getAttachmentPath(): string
Gets the formdefinition attachment path of the current Form

Returns string

`Static`getAttachmentUrl

getAttachmentUrl(filename: string): Promise<string>
Takes the name of a file from the formdefiniton and returns a Promise with the actual file path
Parameters
- filename: string
Returns Promise<string>

`Static`getConditionTable

getConditionTable(): ConditionTable
Get a table of all condition guids of the current Form

Returns ConditionTable

`Static`getLookUpTable

getLookUpTable(): ILookupTable
Get a loolup table of all sections, tabs, blocks, condition controls and fields

Returns ILookupTable

`Static`getProxyHost

getProxyHost(): string
Get the FormDev proxy host specified in the form definition

Returns string

`Static`setApproveButtonLabel

setApproveButtonLabel(text: string): void
Sets the Approve Button label
Parameters
- text: string
  text to be set
Returns void

`Static`setApproveDialogMessage

setApproveDialogMessage(text: string): void
Sets the ApproveDialog message
Parameters
- text: string
  text to be set
Returns void

`Static`setApproveDialogTitle

setApproveDialogTitle(text: string): void
Sets the ApproveDialog title
Parameters
- text: string
  text to be set
Returns void