Interface: DialogExt
CloudControl Pro 9 Docs / dialogs / DialogExt
Interface: DialogExt
dialogs.DialogExt
Dialog type, extends from Dialog to add some events. Created by buildDialog and showDialog.
Dialog event list see on.
Hierarchy
-
unknown↳
DialogExt
Table of contents
Events
Events
on
▸ on(event, listener): DialogExt
positive button click event.
positive
Parameters
| Name | Type |
|---|---|
event |
"positive" |
listener |
(dialog: any) => void |
Returns
▸ on(event, listener): DialogExt
neutral button click event.
neutral
Parameters
| Name | Type |
|---|---|
event |
"neutral" |
listener |
(dialog: any) => void |
Returns
▸ on(event, listener): DialogExt
negative button click event.
neutral
Parameters
| Name | Type |
|---|---|
event |
"negative" |
listener |
(dialog: any) => void |
Returns
▸ on(event, listener): DialogExt
When the dialog box with the single choice box is confirmed or canceled, the selection result is called back by this event. The index parameter is the index of the selected menu item, or -1 if the user deselected it; the text parameter is the text of the selected menu item, or null if the user deselected it.
single_choice
Parameters
| Name | Type |
|---|---|
event |
"single_choice" |
listener |
(index: number, text: null | string, dialog: any) => void |
Returns
▸ on(event, listener): DialogExt
When a dialog box with a multi-select box is confirmed or canceled, the selection result is called back by this event. The indices parameter is the index array of the selected menu items, or an empty array if the user deselects; the texts parameter is the text array of the selected menu items, or an empty array if the user deselects.
multi_choice
Parameters
| Name | Type |
|---|---|
event |
"multi_choice" |
listener |
(indices: number[], texts: string[], dialog: any) => void |
Returns
▸ on(event, listener): DialogExt
When the dialog box with the selection menu is confirmed or canceled, the selection result is called back by this event. The index parameter is the index of the selected menu item, or -1 if the user deselected it; the text parameter is the text of the selected menu item, or null if the user deselected it.
item_select
Parameters
| Name | Type |
|---|---|
event |
"item_select" |
listener |
(index: number, text: null | string, dialog: any) => void |
Returns
▸ on(event, listener): DialogExt
This event is triggered when text in input box changes.
input
Parameters
| Name | Type |
|---|---|
event |
"input_change" |
listener |
(text: string, dialog: any) => void |
Returns
▸ on(event, listener): DialogExt
Dialog with input box, will callback text parameter when user confirm or cancel. If user cancel, text will be null.
input
Parameters
| Name | Type |
|---|---|
event |
"input" |
listener |
(text: string, dialog: any) => void |
Returns
▸ on(event, listener): DialogExt
dialog dismiss event.
dismiss
Parameters
| Name | Type |
|---|---|
event |
"dismiss" |
listener |
(dialog: any) => void |
Returns
▸ on(event, listener): DialogExt
dialog cancel event, e.g. triggered when click outside of the dialog.
cancel
Parameters
| Name | Type |
|---|---|
event |
"cancel" |
listener |
(dialog: any) => void |