OKCancel (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Characteristics of dialog box
Line break in the dialog box
Miscellaneous
Emulation

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.
Versions 25 and later
To avoid blocking the application, use OKCancelAsynchronous.
New in version 25
To avoid blocking the application, use OKCancelAsynchronous.
To avoid blocking the application, use OKCancelAsynchronous.
WINDEV allows you to apply the skin template of your project to this dialog box. See Customizing dialog boxes for more details.

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.

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 on the following lines.

<Line N>: Optional character string

Text displayed on the following lines.

Remarks

Characteristics of 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.

The message is aligned to 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 in parameter, it will be truncated.
The icon displayed (exclamation mark) cannot be modified.

To customize this dialog box (as well as all system dialog boxes of your application), check "Customize the system windows (Info, YesNo, Confirm, Dialog)" in the "Style" tab of the project description. See Customizing dialog boxes for more details.

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

The timers (TimerSys) are not stopped during the call to this function.
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.

Emulation

To emulate an OKCancel message, use EmulateOKCancel.

Business / UI classification : UI Code

Component : wd260obj.dll