ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

This content has been translated automatically.  Click here  to view the French version.
Help / WLanguage / WLanguage functions / Standard functions / Windows functions / Dialog Box functions
  • Using syntax with the wizard
  • Features of the dialog box
  • Miscellaneous
  • Emulation
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Displays a message box and returns the value of the button clicked by the user.
Remarks:
  • This is a modal warning window. To continue running the application, the user must validate one of the buttons.
    WINDEV To avoid blocking the application, use DialogAsynchronous.
  • WINDEV WINDEV allows you to apply the skin template of your project to this dialog box. For more details, see Customize dialog boxes.
Example
// Attention: Cet exemple ne doit pas Ãªtre copié directement.
// Le code suivant est généré par l'assistant.
SWITCH Dialog("Voulez-vous enregistrer les modifications dans le fichier %1?", MySource)
// Oui
CASE 1: 
Procédure_Sauve()
END
// Attention: Cet exemple ne doit pas Ãªtre copié directement.
// Le code suivant est généré par l'assistant.
IF Dialog(StringBuild("Voulez-vous enregistrer les modifications dans le fichier %1?", ...
MySource), ["Oui - Enregistrer","Non"], 1, 2, dlgIconQuestion) = 1 THEN
Procédure_Sauve()
END
Syntax

Syntax using the wizard Hide the details

<Result> = Dialog(<Message identifier> [, <Parameter 1> [, <Parameter N>]])
<Result>: entier
Identifies the answer selected by the user. This answer depends on the selected message. The different values corresponding to the different answers are automatically included in comments in the code editor when selecting the message.
<Message identifier>: entier
Identifies the question asked to the user as well as the different possible answers.
<Parameter 1>: Optional character string
If the selected message contains elements with parameters (identified by %1, %2, etc.), this parameter is used to give the desired value to the first element. Thus, the value of <Parameter 1> will replace %1. $~ ... |
<Parameter N>: Optional character string
If the selected message contains elements with parameters (identified by %1, %2, etc.), this parameter is used to give the Nth desired value to element N. Thus, the value of <Parameter N> will replace %N.

Direct syntax Hide the details

<Result> = Dialog(<Question> , <Captions of buttons> [, <Default button> [, <Cancellation button> [, <Icon>]]])
<Result>: entier
Identifies the answer selected by the user. This answer depends on the selected message.
<Question>: Character string
Question asked to the user.
<Captions of buttons>: Array
Name of the Array variable containing the captions of the buttons.
<Default button>: entier
Index of the button selected by default. This parameter is set to 1 by default.
<Cancellation button>: entier
Index of the cancellation button. By default, this parameter corresponds to the index of the last button.
<Icon>: Character string or Integer constant
Icon displayed. This parameter can correspond to:
  • the path of file corresponding to the displayed icon.
  • one of the following constants:
    dlgIconErrorIcon representing an error.
    dlgIconInfo
    (Default value)
    Icon representing an information.
    dlgIconQuestionIcon representing a question.
Remarks

Using syntax with the wizard

To use this syntax, you must use the wizard proposed when writing the function name in the code editor ("<Wizard>" option proposed by the assisted input). This wizard allows you to specify the different parameters of the dialog box that will be used. This function cannot be used if the dialog window is not created by the wizard.
To start the wizard:
  1. In the code editor, type "Dialog(".
  2. Click "Wizard". The wizard starts. Go to the next step.
  3. Choose an existing question or create a new question (<Click here to create a new question>). Go to the next step.
  4. If you have chosen to create a question, a screen is displayed. This screen allows you to enter the different parameters of the dialog box used to ask the question. You can specify:
    • The text of the question,
    • The image of dialog box,
    • The different buttons allowing the user to answer.
  5. Validate the screen for defining the question. The corresponding code is automatically inserted into the code editor. Press the ENTER key again. The entire code is added in the code editor. The characteristics of dialog box can be modified via the icon found beside the question text.

Features of the dialog box

  • The title of the dialog box corresponds to the title of the current window (or page).
  • To modify or define the title of dialog box, use NextTitle.
  • WINDEV The skin template of current project is automatically applied to the dialog box.
    Java In order for the skin template of project to be applied to the dialog box, you must:
    • apply the skin template to the dialog boxes ("Customize system windows (Info, YesNo, Confirm, Dialog)" in the "Style" tab of the project description window).
    • make sure that the "WinDevMessageBox" window is found in the project.
    Universal Windows 10 App The dialog box displayed uses the system style (the skin template of project is not applied).
WINDEV To customize this dialog box (and all the system dialog boxes in your application), check "Customize system windows (Info, YesNo, Confirm, Dialog)" in the "Style" tab of the project description. For more details, see Customizing dialog boxes.

Miscellaneous

  • WINDEVJava DelayBeforeClosing limits how long the message is displayed. The dialog box is automatically closed. For question or confirmation dialog boxes, the default button corresponds to the expected answer.
  • WINDEVJava To allow the user to type a value in a dialog box, use Seizure.
WINDEV

Emulation

A dialog box can be emulated by EmulateDialog.
Business / UI classification: UI Code
Component: wd290obj.dll
Minimum version required
  • Version 10
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 11/22/2023

Send a report | Local help