Child pages
  • dialogs

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
{div:style=display:none} 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.\\ \\ Enter additional information related to this 'class' inside the \{div} macro with 'id=description'{div} {div:id=description}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|https://www.servoyforge.net] 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|https://www.servoyforge.net/projects/mod-dialog].{div}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[String]{td}{td}[#showErrorDialog]\(dialogTitle, dialogMessage, buttonsText) Shows a message dialog with the specified title, message and a customizable set of buttons.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#showInfoDialog]\(dialogTitle, dialogMessage, buttonsText) Shows a message dialog with the specified title, message and a customizable set of buttons.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#showInputDialog]\() Shows an input dialog where the user can enter data.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#showInputDialog]\(dialog_title) Shows an input dialog where the user can enter data.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#showInputDialog]\(dialog_title, msg) Shows an input dialog where the user can enter data.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#showInputDialog]\(dialog_title, msg, initialValue) Shows an input dialog where the user can enter data.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#showQuestionDialog]\(dialogTitle, dialogMessage) Shows a message dialog with the specified title, message and a customizable set of buttons.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#showQuestionDialog]\(dialogTitle, dialogMessage, buttonsText) Shows a message dialog with the specified title, message and a customizable set of buttons.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#showSelectDialog]\(dialog_title, msg, optionArray) Shows a selection dialog, where the user can select an entry from a list of options.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#showSelectDialog]\(dialog_title, msg, options) Shows a selection dialog, where the user can select an entry from a list of options.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#showWarningDialog]\(dialogTitle, dialogMessage) Shows a message dialog with the specified title, message and a customizable set of buttons.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#showWarningDialog]\(dialogTitle, dialogMessage, buttonsText)
Wiki Markup
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryShows a message dialog with the specified title, message and a customizable set of buttons.Shows a message dialog with the specified title, message and a customizable set of buttons.Shows an input dialog where the user can enter data.Shows an input dialog where the user can enter data.Shows an input dialog where the user can enter data.Shows an input dialog where the user can enter data.Shows a message dialog with the specified title, message and a customizable set of buttons.Shows a message dialog with the specified title, message and a customizable set of buttons.Shows a selection dialog, where the user can select an entry from a list of options.Shows a selection dialog, where the user can select an entry from a list of options.Shows a message dialog with the specified title, message and a customizable set of buttons.Shows a message dialog with the specified title, message and a customizable set of buttons.

functionservoy sDetail2100%height:30px2Methods DetailsshowErrorDialogname

showErrorDialog(dialogTitle, dialogMessage, buttonsText)

dessIndent
Shows a message dialog with the specified title, message and a customizable set of buttons.
{td}{tr}{tbody}{table}\\ {table:id=function|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=showErrorDialog-String_String_StringArray}{tr:id=name}{td}h6.showErrorDialog{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}showErrorDialog{span}{span}\(dialogTitle, dialogMessage, buttonsText){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} dialogTitle -- Dialog title. \{[String]} dialogMessage -- Dialog message. \{[String]...} buttonsText -- Array of button texts. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //show dialog var thePressedButton = plugins.dialogs.showErrorDialog('Title', 'Value not allowed','OK'); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showInfoDialog-String_String_StringArray}{tr:id=name}{td}h6.showInfoDialog{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}showInfoDialog{span}{span}\(dialogTitle, dialogMessage, buttonsText){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} dialogTitle -- Dialog title. \{[String]} dialogMessage -- Dialog message. \{[String]...} buttonsText -- Array of button texts. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //show dialog var thePressedButton = plugins.dialogs.showInfoDialog('Title', 'Value not allowed','OK'); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showInputDialog}{tr:id=name}{td}h6.showInputDialog{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}showInputDialog{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //show input dialog ,returns nothing when canceled var typedInput = plugins.dialogs.showInputDialog('Specify','Your name'); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showInputDialog-String}{tr:id=name}{td}h6.showInputDialog{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}showInputDialog{span}{span}\(dialog_title){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} dialog_title {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //show input dialog ,returns nothing when canceled var typedInput = plugins.dialogs.showInputDialog('Specify','Your name'); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showInputDialog-String_String}{tr:id=name}{td}h6.showInputDialog{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}showInputDialog{span}{span}\(dialog_title, msg){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} dialog_title \{[String]} msg {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //show input dialog ,returns nothing when canceled var typedInput = plugins.dialogs.showInputDialog('Specify','Your name'); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showInputDialog-String_String_String}{tr:id=name}{td}h6.showInputDialog{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}showInputDialog{span}{span}\(dialog_title, msg, initialValue){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} dialog_title \{[String]} msg \{[String]} initialValue {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //show input dialog ,returns nothing when canceled var typedInput = plugins.dialogs.showInputDialog('Specify','Your name'); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showQuestionDialog-String_String}{tr:id=name}{td}h6.showQuestionDialog{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}showQuestionDialog{span}{span}\(dialogTitle, dialogMessage){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} dialogTitle -- Dialog title. \{[String]} dialogMessage -- Dialog message. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //show dialog var thePressedButton = plugins.dialogs.showQuestionDialog('Title', 'Value not allowed','OK'); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showQuestionDialog-String_String_StringArray}{tr:id=name}{td}h6.showQuestionDialog{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}showQuestionDialog{span}{span}\(dialogTitle, dialogMessage, buttonsText){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} dialogTitle -- Dialog title. \{[String]} dialogMessage -- Dialog message. \{[String]...} buttonsText -- Array of button texts. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //show dialog var thePressedButton = plugins.dialogs.showQuestionDialog('Title', 'Value not allowed','OK'); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showSelectDialog-String_String_ObjectArray}{tr:id=name}{td}h6.showSelectDialog{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}showSelectDialog{span}{span}\(dialog_title, msg, optionArray){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} dialog_title \{[String]} msg \{[Object]\[]} optionArray {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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')); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showSelectDialog-String_String_StringArray}{tr:id=name}{td}h6.showSelectDialog{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}showSelectDialog{span}{span}\(dialog_title, msg, options){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} dialog_title \{[String]} msg \{[String]...} options {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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')); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showWarningDialog-String_String}{tr:id=name}{td}h6.showWarningDialog{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}showWarningDialog{span}{span}\(dialogTitle, dialogMessage){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} dialogTitle -- Dialog title. \{[String]} dialogMessage -- Dialog message. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //show dialog var thePressedButton = plugins.dialogs.showWarningDialog('Title', 'Value not allowed'); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showWarningDialog-String_String_StringArray}{tr:id=name}{td}h6.showWarningDialog{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}showWarningDialog{span}{span}\(dialogTitle, dialogMessage, buttonsText){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} dialogTitle -- Dialog title. \{[String]} dialogMessage -- Dialog message. \{[String]...} buttonsText -- Array of button texts. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //show dialog var thePressedButton = plugins.dialogs.showWarningDialog('Title', 'Value not allowed','OK'); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}

Returns pressed button text, in case window is closed without pressing any button return value depends on client type.
prs

Parameters

sIndentdialogTitleDialog title.dialogMessageDialog message.buttonsTextArray of button texts.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showInfoDialogname

showInfoDialog(dialogTitle, dialogMessage, buttonsText)

dessIndent
Shows a message dialog with the specified title, message and a customizable set of buttons.
Returns pressed button text, in case window is closed without pressing any button return value depends on client type.
prs

Parameters

sIndentdialogTitleDialog title.dialogMessageDialog message.buttonsTextArray of button texts.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showInputDialogname

showInputDialog()

dessIndent
Shows an input dialog where the user can enter data. Returns the entered data, or nothing when canceled.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showInputDialogname

showInputDialog(dialog_title)

dessIndent
Shows an input dialog where the user can enter data. Returns the entered data, or nothing when canceled.
prs

Parameters

sIndentdialog_title ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showInputDialogname

showInputDialog(dialog_title, msg)

dessIndent
Shows an input dialog where the user can enter data. Returns the entered data, or nothing when canceled.
prs

Parameters

sIndentdialog_title ;msg ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showInputDialogname

showInputDialog(dialog_title, msg, initialValue)

dessIndent
Shows an input dialog where the user can enter data. Returns the entered data, or nothing when canceled.
prs

Parameters

sIndentdialog_title ;msg ;initialValue ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showQuestionDialogname

showQuestionDialog(dialogTitle, dialogMessage)

dessIndent
Shows a message dialog with the specified title, message and a customizable set of buttons.
Returns pressed button text, in case window is closed without pressing any button return value depends on client type.
prs

Parameters

sIndentdialogTitleDialog title.dialogMessageDialog message.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
showQuestionDialogname

showQuestionDialog(dialogTitle, dialogMessage, buttonsText)

dessIndent
Shows a message dialog with the specified title, message and a customizable set of buttons.
Returns pressed button text, in case window is closed without pressing any button return value depends on client type.
prs

Parameters

sIndentdialogTitleDialog title.dialogMessageDialog message.buttonsTextArray of button texts.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showSelectDialogname

showSelectDialog(dialog_title, msg, optionArray)

dessIndent
Shows a selection dialog, where the user can select an entry from a list of options. Returns the selected entry, or nothing when canceled.
prs

Parameters

sIndentdialog_title ;msg ;optionArray ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showSelectDialogname

showSelectDialog(dialog_title, msg, options)

dessIndent
Shows a selection dialog, where the user can select an entry from a list of options. Returns the selected entry, or nothing when canceled.
prs

Parameters

sIndentdialog_title ;msg ;options ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showWarningDialogname

showWarningDialog(dialogTitle, dialogMessage)

dessIndent
Shows a message dialog with the specified title, message and a customizable set of buttons.
Returns pressed button text, in case window is closed without pressing any button return value depends on client type.
prs

Parameters

sIndentdialogTitleDialog title.dialogMessageDialog message.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
showWarningDialogname

showWarningDialog(dialogTitle, dialogMessage, buttonsText)

dessIndent
Shows a message dialog with the specified title, message and a customizable set of buttons.
Returns pressed button text, in case window is closed without pressing any button return value depends on client type.
prs

Parameters

sIndentdialogTitleDialog title.dialogMessageDialog message.buttonsTextArray of button texts.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow