Dialog (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

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
Background application: Specific to Android 10 and higher

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Dialog (Function)

In french: Dialogue

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.
To avoid blocking the application, use DialogAsynchronous.
WINDEV allows you to apply the skin template of your project to this dialog box. For more details, see Customizing 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 ID> [, <Parameter 1> [, <Parameter N>]])

<Result>: Integer

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 ID>: Integer

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>: Integer

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>: Integer

Index of the button selected by default. This parameter is set to 1 by default.

<Cancellation button>: Integer

Index of the cancellation button. By default, this parameter corresponds to the index of the last button.

<Icon>: Character string or Integer constant

Displayed icon. This parameter can correspond to:
the path of file corresponding to the displayed icon.
one of the following constants:
dlgIconError Icon representing an error.
dlgIconInfo
(Default value) Icon representing an information.
dlgIconQuestion Icon 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:

In the code editor, type "Dialog(".
Click "Wizard". The wizard starts. Go to the next step.
Choose an existing question or create a new question (<Click here to create a new question>). Go to the next step.
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.
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 comply with the system specifications, the title of dialog box is empty by default. To define this title, use NextTitle.
To modify or define the title of dialog box, use NextTitle.

The skin template of current project is automatically applied to the dialog box.
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.
The dialog box features are as follows:
- The displayed dialog box uses the system style.
- The dialog box must not contain more than 3 buttons. The additional buttons will not be displayed.
- The position of the buttons varies according to the Android version. From Android version 4.1, the validation button is positioned on the right. To change the order of the buttons, open the question edit wizard and uncheck "Use the order defined by the system for the validation/cancellation buttons".
The displayed dialog box is a native iPhone/iPad dialog box.

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

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.
To allow the user to type a value in a dialog box, use Input.
This function must not be used:
- in the "Resize" event of the window. Otherwise, the application will be locked.
- in the "Change the orientation" event of the window.
- in the "Move to the foreground" event associated with the project.
  Note: The function can also be used in the "Bring to foreground" event of a window..
- in a thread.
Special cases:
- If your project uses pre-launched sessions, this function must not be used in the project initialization event. This function must be used in the "Initialization in pre-launched session mode" event.
- This function must not be used in a scheduled WEBDEV task.

Emulation

A dialog box can be emulated by EmulateDialog.

Background application: Specific to Android 10 and higher

Starting with Android 10, it is no longer possible to open a window when the application is in the background.

Dialog can open a window. If this function is used while the application is in the background, a fatal error will occur.

Tips:

It is possible to determine if the application is in the background using InBackgroundMode.
If an application needs to interact with the user while it is in the background, the solution is to display a notification (via the Notification type). The application will be brought back to the foreground when the notification is clicked, if the ActivateApplication property is set to True. You can also open a window from the procedure passed to the ActionClick property.

For more details, see Android 10: Application behavior in the background.

Business / UI classification: UI Code

Component: wd300obj.dll