Interface DialogCreator

Dialog creator API.

Hierarchy

DialogCreator

Index

Properties

Dialog

Methods

Properties

Dialog

Dialog: { prototype: Dialog }

Represents a dialog object.

Type declaration

prototype: Dialog

Methods

alert

alert(message: string, properties?: DialogParams): Dialog

- Defined in apis/ui/dlgcreator.d.ts:202
Shows a simple alert box.

Parameters
- message: string
  
  The message to show.
- Optional properties: DialogParams
  
  Additonal DlgCreator properties to pass.
Returns Dialog

confirm

confirm(message: string, properties?: DialogParams, callback?: (v: boolean) => void): Dialog

- Defined in apis/ui/dlgcreator.d.ts:210
Show a confirmation prompt.

Parameters
- message: string
  
  The message for the prompt.
- Optional properties: DialogParams
  
  Additional DlgCreator options to append.
- Optional callback: (v: boolean) => void
  
  Callback upon decision complete.
  - - (v: boolean): void
    - Parameters
      - v: boolean
      Returns void
Returns Dialog

create

create(props: DialogParams): Dialog

- Defined in apis/ui/dlgcreator.d.ts:224
Creates a dialog.

Parameters
- props: DialogParams
  
  The properties to use.
Returns Dialog

fieldset

fieldset(fieldObjects: FieldsetObject[], properties?: DialogParams, callback?: (values?: FieldsetKVP[]) => void): Dialog

- Defined in apis/ui/dlgcreator.d.ts:195
Creates a dialog containing a set of fields (useful for forms).

Parameters
- fieldObjects: FieldsetObject[]
  
  The field objects to use.
- Optional properties: DialogParams
  
  Additonal DlgCreator properties to pass.
- Optional callback: (values?: FieldsetKVP[]) => void
  
  Callback.
  - - (values?: FieldsetKVP[]): void
    - Parameters
      - Optional values: FieldsetKVP[]
      Returns void
Returns Dialog

progress

progress(message: string, properties?: ProgressDialogParams): ProgressDialog

- Defined in apis/ui/dlgcreator.d.ts:187
Shows a progress dialog.

Parameters
- message: string
  
  The message to show.
- Optional properties: ProgressDialogParams
  
  Progress dialog properties.
Returns ProgressDialog

prompt

prompt(message: string, properties?: DialogParams, callback?: (value?: string) => void): Dialog

- Defined in apis/ui/dlgcreator.d.ts:218
Shows a prompt.

Parameters
- message: string
  
  The prompt message.
- Optional properties: DialogParams
  
  Additional DlgCreator properties to append.
- Optional callback: (value?: string) => void
  
  The callback to call upon prompt completion.
  - - (value?: string): void
    - Parameters
      - Optional value: string
      Returns void
Returns Dialog

Generated using TypeDoc