Dialog (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Windows management functions

Using syntax with the wizard

Characteristics of dialog box

Miscellaneous

Emulation

Application in the background: Android 10 specific case

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 blocking warning window. To continue running the application, the user must validate one of the buttons.
Versions 25 and later
To avoid blocking the application, use DialogAsynchronous.
New in version 25
To avoid blocking the application, use DialogAsynchronous.
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.

Versions 16 and later

This function is now available for WINDEV applications in Linux.

New in version 16

This function is now available for WINDEV applications in Linux.

Versions 19 and later

This function is now available for iPhone/iPad applications.

New in version 19

This function is now available for iPhone/iPad applications.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Versions 24 and later

This function is now available for WEBDEV sites in Linux.

This function is now available for WEBDEV sites in Windows.

New in version 24

This function is now available for WEBDEV sites in Linux.

This function is now available for WEBDEV sites in Windows.

This function is now available for WEBDEV sites in Linux.

This function is now available for WEBDEV sites in Windows.

Example

// Caution: This example must not be copied directly.
// The following code is generated by the wizard.
SWITCH Dialog("Do you want to save the modifications in the %1? file", MySource)
// Yes
CASE 1:
Procedure_Save()
END

Versions 20 and later

// Caution: This example must not be copied directly.
// The following code is generated by the wizard.
IF Dialog(StringBuild("Do you want to save the modifications in %1?", ...
MySource), ["Yes - Save","No"], 1, 2, dlgIconQuestion) = 1 THEN
Procedure_Save()
END

New in version 20

Syntax

Syntax using the wizard Hide the details

<Result> = Dialog(<Message identifier> [, <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 identifier>: 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.

Versions 20 and later

Direct syntax Hide the details

<Result> = Dialog(<Question> , <Captions of buttons> [, <Default button> [, <Cancelation button> [, <Icon>]]])

<Result>: Integer

Identifies the answer selected by the user. This answer depends on the selected message.

<Question>: Character string (with quotes)

Question asked to the user.

<Captions of buttons>: Array

Name of Array variable containing the captions of buttons.

<Default button>: Integer

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

<Cancelation button>: Integer

Subscript of cancelation button. By default, this parameter corresponds to the subscript of last button.

<Icon>: Character string (with quotes) or Integer constant

Icon displayed. 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.

New in version 20

Direct syntax Hide the details

<Result> = Dialog(<Question> , <Captions of buttons> [, <Default button> [, <Cancelation button> [, <Icon>]]])

<Result>: Integer

Identifies the answer selected by the user. This answer depends on the selected message.

<Question>: Character string (with quotes)

Question asked to the user.

<Captions of buttons>: Array

Name of Array variable containing the captions of buttons.

<Default button>: Integer

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

<Cancelation button>: Integer

Subscript of cancelation button. By default, this parameter corresponds to the subscript of last button.

<Icon>: Character string (with quotes) or Integer constant

Icon displayed. 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.

Direct syntax Hide the details

<Result> = Dialog(<Question> , <Captions of buttons> [, <Default button> [, <Cancelation button> [, <Icon>]]])

<Result>: Integer

Identifies the answer selected by the user. This answer depends on the selected message.

<Question>: Character string (with quotes)

Question asked to the user.

<Captions of buttons>: Array

Name of Array variable containing the captions of buttons.

<Default button>: Integer

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

<Cancelation button>: Integer

Subscript of cancelation button. By default, this parameter corresponds to the subscript of last button.

<Icon>: Character string (with quotes) or Integer constant

Icon displayed. 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.

Characteristics of 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 the 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 displayed uses the system style (the skin template of project is not applied).
The characteristics of dialog box are as follows:
- The displayed dialog box is using 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 the 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 event "Resizing" of the window. Otherwise, the application will be locked.
- in the event "Changing the orientation" of the window.
- in the event "Move to the foreground" associated with the project.
  Remark: However, the function can be used in the event "Move to the foreground" of a window.
- in a thread.
Versions 24 and later
Special cases:
- If your project uses pre-launched sessions, this function must not be used in the "Initializing" event of the project. It must be used in the event "Initializing the project after connection to the site".
- This function must not be used in a scheduled WEBDEV task.
New in version 24
Special cases:
- If your project uses pre-launched sessions, this function must not be used in the "Initializing" event of the project. It must be used in the event "Initializing the project after connection to the site".
- This function must not be used in a scheduled WEBDEV task.
Special cases:
- If your project uses pre-launched sessions, this function must not be used in the "Initializing" event of the project. It must be used in the event "Initializing the project after connection to the site".
- This function must not be used in a scheduled WEBDEV task.

Emulation

A dialog box can be emulated by EmulateDialog.

Versions 25 and later

Application in the background: Android 10 specific case

From 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: Behavior of applications in the background.

New in version 25

Application in the background: Android 10 specific case

From 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: Behavior of applications in the background.

Application in the background: Android 10 specific case

From 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: Behavior of applications in the background.

Business / UI classification : UI Code

Component : wd260obj.dll