Skip to main content
Version: v11.7.1

Confirm Dialog


confirm_struct

Overview

Dragging and dropping a dialog creates a view containing the dialog. The view can be selected from the Page Structure or from the tabs given at the bottom. The display of the dialog box at runtime is usually associated with the onClick event of a Button widget. You can also trigger the dialog by calling methods from JavaScript.

Confirm Dialog

Confirm Dialog is used to get confirmation from the user. In addition to the properties mentioned for Alert Dialog, it has an additional Cancel button. The most common usage is to confirm a delete action.

Script Access

Dialog widget in your project can be accessed by associating the open and close properties of the dialog with an event of any other widget. The dialog can be accessed through scripting by adding DialogService to the page controller and adding the code for open and close as shown below, here we are displaying an alert dialog on click of a button: Click event of the button should trigger the following JavaScript code:

Page.button3Click = function($event, widget) {
Page.Widgets.confirmdialog1.open();
}

For hiding dialog:

/* function called on button1 click */
Page.button1Click = function($event, widget) {
Page.Widgets.confirmdialog1.close();
};

Properties & Events


Confirm Dialog Properties

PropertyDescription
TitleSet the title of the widget.
NameThe name is a unique identifier for the confirm dialog.
MessageSet the display message for the widget.
Ok TextThis Confirm Dialog prompts to get confirmation from the user.
Cancel TextThis widget gives a pop-up window. It can be used to get confirmation of an action from the user. For example, do you want to delete this item?
Accessibility
Tab indexThe tab index attribute specifies the tab order of an element. You can use this property to change the default tabbing order for widget access using the tab key. The value can range from 0 to 32767. The default is 0 and -1 makes the element non-focusable. NOTE: In Safari browsers, by default, Tab highlights only text fields. To enable Tab functionality, in Safari Browser from Preferences -> Advanced -> Accessibility set the option "Press Tab to highlight each item on a webpage".
Layout
WidthThe width of your widget can be specified in px or % (i.e 50px, 75%).
HeightThe height of your widget can be specified in px or % (i.e 50px, 75%).
ModalThis property, if set true, adds a backdrop for the dialog restricting the closure of the dialog when the user clicks outside of the dialog. The default value is false, which allows close of dialog on click outside.
Behavior
Enable Default Close ActionThis property allows the user to access close action from header through an "x" icon; and also enables close through ESC key.
AnimationThis property controls the animation of an element. The animation is based on the CSS classes and works only in the run mode.
KeyboardThis property if set true allows closing of dialog on ESC keypress. The default is true.
Graphics
Icon ClassThis property defines the class of the icon that is applied to the button.
Icon WidthOptional property; but you will need this if you are using the button's iconUrl. Please enter the width of your icon. WARNING: It's best to specify size in pixels, not percent.
Icon HeightOptional property; but you will need this if you are using the button's iconUrl. Please enter the height of your icon. WARNING: It's best to specify size in pixels, not percent.
Icon MarginOptional property; only has meaning if you specify the button's iconUrl. Values should all have "px" next to them. Use this to adjust the space between the icon and the button text.

Confirm Dialog Events

EventDescription
Callback Events
On okThis event handler is called whenever an ok event is triggered.
On cancelThis event handler is called whenever a cancel event is triggered.
On closeThis event handler is called whenever a close event is triggered.
On openThis widget gives a pop-up window. It can be used to give a warning message to the user. For example, you are about to leave this page.