OKCancel (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

Features of the dialog box
Line break in the dialog box
Miscellaneous

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.

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.

Remarks

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.

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.

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("Warning: you are about to delete this record" + CR + ...
	"Do you want to continue?") THEN
	HDelete(CUSTOMER)
END

is equivalent to:

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

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

OKCancel(
[
Warning: you will delete this record.

Do you want to continue?
])

Miscellaneous

Timers (TimerSys) are not stopped when this function is called.
The text of the buttons is displayed in the system language.

Business / UI classification: UI Code

Component: wd300obj.dll