DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

The Dialogs plugin provides a few convenient functions to quickly show a dialog. It supports the following types of dialogs:

  • Error dialog
  • Info dialog
  • Input dialog
  • Question dialog
  • Select dialog
  • Warning dialog

Currently this plugin is only supported in the Smart Client. ServoyForge hosts a drop-in replacement for the Dialogs plugin adds support for the same type of Dialogs and this plugin, but then equally supported in both the Smart and Web Client. This Dialogs module can be found here .



Method Summary
String
showErrorDialog(dialogTitle, dialogMessage, buttonsText)
Shows a message dialog with the specified title, message and a customizable set of buttons.
String
showInfoDialog(dialogTitle, dialogMessage, buttonsText)
Shows a message dialog with the specified title, message and a customizable set of buttons.
String
showInputDialog()
Shows an input dialog where the user can enter data.
String
showInputDialog(dialog_title)
Shows an input dialog where the user can enter data.
String
showInputDialog(dialog_title, msg)
Shows an input dialog where the user can enter data.
String
showInputDialog(dialog_title, msg, initialValue)
Shows an input dialog where the user can enter data.
String
showQuestionDialog(dialogTitle, dialogMessage)
Shows a message dialog with the specified title, message and a customizable set of buttons.
String
showQuestionDialog(dialogTitle, dialogMessage, buttonsText)
Shows a message dialog with the specified title, message and a customizable set of buttons.
String
showSelectDialog(dialog_title, msg, optionArray)
Shows a selection dialog, where the user can select an entry from a list of options.
String
showSelectDialog(dialog_title, msg, options)
Shows a selection dialog, where the user can select an entry from a list of options.
String
showWarningDialog(dialogTitle, dialogMessage)
Shows a message dialog with the specified title, message and a customizable set of buttons.
String
showWarningDialog(dialogTitle, dialogMessage, buttonsText)
Shows a message dialog with the specified title, message and a customizable set of buttons.



Method Details

showErrorDialog

String
showErrorDialog
(dialogTitle, dialogMessage, buttonsText)
Shows a message dialog with the specified title, message and a customizable set of buttons.

Parameters

{String} dialogTitle - Dialog title.
{String} dialogMessage - Dialog message.
{String...} buttonsText - Array of button texts.

Returns

String

Sample

//show dialog
var thePressedButton = plugins.dialogs.showErrorDialog('Title', 'Value not allowed','OK');
 

showInfoDialog

String
showInfoDialog
(dialogTitle, dialogMessage, buttonsText)
Shows a message dialog with the specified title, message and a customizable set of buttons.

Parameters

{String} dialogTitle - Dialog title.
{String} dialogMessage - Dialog message.
{String...} buttonsText - Array of button texts.

Returns

String

Sample

//show dialog
var thePressedButton = plugins.dialogs.showInfoDialog('Title', 'Value not allowed','OK');
 

showInputDialog

String
showInputDialog
()
Shows an input dialog where the user can enter data. Returns the entered data, or nothing when canceled.

Returns

String

Sample

//show input dialog ,returns nothing when canceled
var typedInput = plugins.dialogs.showInputDialog('Specify','Your name');
 

showInputDialog

String
showInputDialog
(dialog_title)
Shows an input dialog where the user can enter data. Returns the entered data, or nothing when canceled.

Parameters

{String} dialog_title

Returns

String

Sample

//show input dialog ,returns nothing when canceled
var typedInput = plugins.dialogs.showInputDialog('Specify','Your name');
 

showInputDialog

String
showInputDialog
(dialog_title, msg)
Shows an input dialog where the user can enter data. Returns the entered data, or nothing when canceled.

Parameters

{String} dialog_title
{String} msg

Returns

String

Sample

//show input dialog ,returns nothing when canceled
var typedInput = plugins.dialogs.showInputDialog('Specify','Your name');
 

showInputDialog

String
showInputDialog
(dialog_title, msg, initialValue)
Shows an input dialog where the user can enter data. Returns the entered data, or nothing when canceled.

Parameters

{String} dialog_title
{String} msg
{String} initialValue

Returns

String

Sample

//show input dialog ,returns nothing when canceled
var typedInput = plugins.dialogs.showInputDialog('Specify','Your name');
 

showQuestionDialog

String
showQuestionDialog
(dialogTitle, dialogMessage)
Shows a message dialog with the specified title, message and a customizable set of buttons.

Parameters

{String} dialogTitle - Dialog title.
{String} dialogMessage - Dialog message.

Returns

String

Sample

//show dialog
var thePressedButton = plugins.dialogs.showQuestionDialog('Title', 'Value not allowed','OK');
 

showQuestionDialog

String
showQuestionDialog
(dialogTitle, dialogMessage, buttonsText)
Shows a message dialog with the specified title, message and a customizable set of buttons.

Parameters

{String} dialogTitle - Dialog title.
{String} dialogMessage - Dialog message.
{String...} buttonsText - Array of button texts.

Returns

String

Sample

//show dialog
var thePressedButton = plugins.dialogs.showQuestionDialog('Title', 'Value not allowed','OK');
 

showSelectDialog

String
showSelectDialog
(dialog_title, msg, optionArray)
Shows a selection dialog, where the user can select an entry from a list of options. Returns the selected entry, or nothing when canceled.

Parameters

{String} dialog_title
{String} msg
{Object[]} optionArray

Returns

String

Sample

//show select,returns nothing when canceled
var selectedValue = plugins.dialogs.showSelectDialog('Select','please select a name','jan','johan','sebastiaan');
//also possible to pass array with options
//var selectedValue = plugins.dialogs.showSelectDialog('Select','please select a name', new Array('jan','johan','sebastiaan'));
 

showSelectDialog

String
showSelectDialog
(dialog_title, msg, options)
Shows a selection dialog, where the user can select an entry from a list of options. Returns the selected entry, or nothing when canceled.

Parameters

{String} dialog_title
{String} msg
{String...} options

Returns

String

Sample

//show select,returns nothing when canceled
var selectedValue = plugins.dialogs.showSelectDialog('Select','please select a name','jan','johan','sebastiaan');
//also possible to pass array with options
//var selectedValue = plugins.dialogs.showSelectDialog('Select','please select a name', new Array('jan','johan','sebastiaan'));
 

showWarningDialog

String
showWarningDialog
(dialogTitle, dialogMessage)
Shows a message dialog with the specified title, message and a customizable set of buttons.

Parameters

{String} dialogTitle - Dialog title.
{String} dialogMessage - Dialog message.

Returns

String

Sample

//show dialog
var thePressedButton = plugins.dialogs.showWarningDialog('Title', 'Value not allowed');
 

showWarningDialog

String
showWarningDialog
(dialogTitle, dialogMessage, buttonsText)
Shows a message dialog with the specified title, message and a customizable set of buttons.

Parameters

{String} dialogTitle - Dialog title.
{String} dialogMessage - Dialog message.
{String...} buttonsText - Array of button texts.

Returns

String

Sample

//show dialog
var thePressedButton = plugins.dialogs.showWarningDialog('Title', 'Value not allowed','OK');