Interface DialogParams

Represents dialog paramters.

Hierarchy

DialogParams
- ProgressDialogParams

Index

Properties

Properties

Optional body

body: string

Dialog text.

Optional buttons

buttons: DialogButton[]

Dialog buttons.

Optional events

events: { onclose: any; onshown: any }

Type declaration

onclose: function
- onclose(e?: { dlg: Dialog; e: any }): void
- - Defined in apis/ui/dlgcreator.d.ts:43
  Parameters
  - Optional e: { dlg: Dialog; e: any }
    - dlg: Dialog
    - e: any
  Returns void
onshown: function
- onshown(e?: { dlg: Dialog }): void
- - Defined in apis/ui/dlgcreator.d.ts:44
  Parameters
  - Optional e: { dlg: Dialog }
    - dlg: Dialog
  Returns void

Optional icon

icon: string

The icon to use.

Optional maxHeight

maxHeight: number

Max dialog height.

Optional maxWidth

maxWidth: number

Max dialog width.

Optional noComments

noComments: boolean

[internal] Whether to disable comments.

Optional sounds

sounds: { error: string; info: string; question: string; warning: string }

Dialog sounds.

Type declaration

error: string
info: string
question: string
warning: string

Optional title

title: string

The dialog title.

Generated using TypeDoc