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

// Suppression d'une ligne avec confirmation (oui par défaut)
IF OKCancel("Supprimer cet enregistrement ?") THEN
	HDelete(CLIENT)
END

// Choix pour la sortie du programme
IF OKCancel("Voulez-vous quitter le programme?") = Yes THEN
	Close()
END

// Demande de confirmation de la suppression du fichier dont 
// le nom est contenu dans la variable NOM_FIC, avec 
// positionnement sur le bouton "Non" de la fenêtre OKAnnuler
IF OKCancel(No, "Supprimer le fichier ?") THEN
	fDelete(NOM_FIC)
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.

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.

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("Attention : vous allez supprimer cet enregistrement" + CR + ...
	"Voulez-vous continuer ?") THEN
	HDelete(CLIENT)
END

is equivalent to:

IF OKCancel("Attention : vous allez supprimer cet enregistrement", ...
	"Voulez-vous continuer ?") THEN
	HDelete(CLIENT)
END

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

OKCancel(
[
Attention : vous allez supprimer cet enregistrement.

Voulez-vous continuer ?
])

Miscellaneous

Timers (TimerSys) are not stopped when this function is called.
Windows events are not stopped when this function is called.
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: wd300obj.dll