OKCancel (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Standard functions / Windows functions / Dialog Box functions

Features of the dialog box
Displaying the dialog box
Line break in the dialog box
Miscellaneous
Emulation
Application in the background: Specific case from Android 10

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

OKCancel (Function)

In french: OKAnnuler

Displays a message in a standard dialog box that proposes "OK" and "Cancel" and returns the user's choice.

Remarks:

This is a blocking dialog box. To continue running the application, the user must validate one of the buttons.
To avoid blocking the application, use OKCancelAsynchronous.
WINDEV allows you to apply the skin template of your project to this dialog box. For more details, see Customizing dialog boxes.

Example

// Delete a line with confirmation (yes by default)
IF OKCancel("Delete this record?") THEN
HDelete(CUSTOMER)
END

// Choice used to exit the program
IF OKCancel("Do you want to exit from the program?") = Yes THEN
Close()
END

// Ask to confirm the deletion of the file whose
// name is found in the FILE_NAME variable, with
// positioning on the "No" button in the OKCancel window
IF OKCancel(No, "Delete the file?") THEN
fDelete(FILE_NAME)
END

Syntax

Displaying an OK/Cancel dialog box Hide the details

<Result> = OKCancel([<Selected button>, ] <Text> [, <Line 2> [... [, <Line N>]]])

<Result>: Boolean

Identifies the button selected by the user:
False The "Cancel" button was chosen by the user.
True The "OK" button was chosen by the user.

<Selected button>: Optional boolean

Button selected by default in the dialog box:
No "Cancel" button selected by default.
True
(by default) "OK" button selected by default.

<Text>: Character string

Text to display.

<Line 2>: Optional character string

Text displayed in the following lines.

<Line N>: Optional character string

Text displayed in the following lines.

Displaying an OK/Cancel dialog box on the browser Hide the details

OKCancel([<Selected button>, ] <Code for OK> , <Code for cancel> , <Text> [, <Line 2> [... [, <Line N>]]])

<Selected button>: Optional boolean

Button selected by default in the dialog box:
No "Cancel" button selected by default.
True
(by default) "OK" button selected by default.

<Code for OK>: Character string

Code to run if the OK button is chosen by the Web user. This parameter can correspond to:
the name of a button. If the OK button is selected, the click code of this button will be run.
the name of a browser function or procedure. If the OK button is selected, this procedure will be run.
a string or another value. If the OK button is selected, the value will be run as being a JavaScript code.

<Code for cancel>: Character string

Code to run if the Cancel button is chosen by the Web user. This parameter can correspond to:
the name of a button. If the Cancel button is selected, the click code of this button will be run.
the name of a browser function or procedure. If the Cancel button is selected, this procedure will be run.
a string or another value. If the Cancel button is selected, the value will be run as being a JavaScript code.

<Text>: Character string

Text to display.

<Line 2>: Optional character string

Text displayed in the following lines.

<Line N>: Optional character string

Text displayed in the following lines.

Remarks

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 message is aligned to the left.
The captions of buttons depend on the runtime language of Windows.
The maximum number of characters cannot exceed 4096. If a larger string is passed as parameter, it will be truncated.
The icon displayed (exclamation mark) cannot be modified.

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.

To customize this dialog box (and all the system dialog boxes in your site), check "Apply the skin to the dialog boxes (YesNo and OKCancel)" in the "Skin" tab of the project description window.

Displaying the dialog box

The dialog box does not lock other processes. The dialog box is displayed in the center of the page, with a DDW effect (Dim Disabled Windows).

OKCancel uses the internal page named "WEBDEVOKCancel". To include this page in your project:

Click in the quick access buttons.
The new element window appears: click "Page" then "Page".
Click "Internal page" in the wizard and select the internal page named "OK/Cancel".
Validate. The "WEBDEVOKCancel" page is displayed in the editor.
Save the page by keeping its default name.

Line break in the dialog box

The CR string (Carriage Return) can be used to force a break to the next line. For example:

IF OKCancel("Caution: you are going to delete this record" + CR + ...
"Do you want to continue?") THEN
HDelete(CUSTOMER)
END

is equivalent to:

IF OKCancel("Caution: this record will be deleted", ...
"Do you want to continue?") THEN
HDelete(CUSTOMER)
END

You also have the ability to use the syntax of multiline strings. For example:

OKCancel(
[
Caution: you are going to delete this record.

Do you want to continue?
])

Miscellaneous

Timers (TimerSys) are not stopped when this function is called.
Windows events are not stopped when this function is called.
You can use the code wizard to enter the function in the code editor. Depending on the characteristics entered in the wizard, the function used can be different in the code that is automatically generated.
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.
The text of the buttons is displayed in the system language.
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 "Initialize project after connecting to the site" event.
This function must not be used:
- in the "Resizing" event of the window. Otherwise, the application will be locked.
- in the "Changing the orientation" event of the window.
- in the "Move to the foreground" event associated with the project.
  Remark: However, the function can be used in the "Move to the foreground" event of a window.
- in a thread.

Emulation

To emulate an OKCancel message, use EmulateOKCancel.

Application in the background: Specific case from Android 10

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

OKCancel 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: wd290obj.dll