OKCancel (Function)

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Characteristics of dialog box
Displaying the dialog box
Line break in the dialog box
Various
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.

To close the window, the user must validate one of the buttons.

WINDEV allows you to apply the skin template of your project to this dialog box. See Customizing the dialog boxes for more details.

Versions 15 and later

This function is now available for the Android applications.

New in version 15

This function is now available for the Android applications.

Versions 17 and later

This function is now available for the iPhone/iPad applications.

New in version 17

This function is now available for the 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 in Ajax mode.

New in version 24

This function is now available in Ajax mode.

Example

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

// Choice used to exit from 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 selected by default
True
(by default) 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.

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 (with quotes)

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 (with quotes)

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 (with quotes)

Text to display.

<Line 2>: Optional character string (with quotes)

Text displayed on the following lines.

<Line N>: Optional character string (with quotes)

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 comply with the system specifications, the title of dialog box is empty by default. To define this title, use NextTitle. 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 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 "Apply the theme of skin template to the system information windows" in the "Style" tab of project description. See Customizing the dialog boxes for more details.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 project description. See Customizing the dialog boxes for more details.

Versions 16 and later

To customize this dialog box (as well as all system dialog boxes of your site), check "Apply the skin to the dialog boxes (Info, YesNon, Confirm, ...)" in the "Style" tab of project description.

New in version 16

To customize this dialog box (as well as all system dialog boxes of your site), check "Apply the skin to the dialog boxes (Info, YesNon, Confirm, ...)" in the "Style" tab of project description.

Displaying the dialog box

The display of the dialog box is not a locking operation. The dialog box is displayed in the center of the page, with a DDW effect (Dim Disabled Windows).

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

Select "File .. New .. Page".Click among the quick access buttons. Click "Page" in the wheel that is displayed. The window for creating a new element is displayed: click "Page" then "Page".
In the "Internal page" tab, select the internal page named "OK/Cancel".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

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

Various

The timers (TimerSys) and the events are not stopped when this function is called.
When typing the function in the code editor, you have the ability to use the code wizard. Depending on the characteristics entered in the wizard, the function used can be different in the code that is automatically generated.
DelayBeforeClosing is used to limit the display duration of the message. The dialog box is automatically closed. For the question or confirmation dialog boxes, the expected answer corresponds to the default button.
The caption of buttons is displayed in the language used by Windows on the current computer.
Versions 20 and later
If your project is using cached sessions, this function must not be used in the "Initializing the project" process. This function must be used in the "Initializing the project after connection to the site" process.
New in version 20
If your project is using cached sessions, this function must not be used in the "Initializing the project" process. This function must be used in the "Initializing the project after connection to the site" process.
If your project is using cached sessions, this function must not be used in the "Initializing the project" process. This function must be used in the "Initializing the project after connection to the site" process.
This function must not be used:
- in the process for resizing windows. Otherwise, the application will be locked.
- in the process for changing the orientation of windows.
- in the "Move to the foreground" process associated with the project.
  Note: However, the function can be used in the "Move to the foreground" process of a window.
- in a thread.

Emulation

To emulate an OKCancel message, use EmulateOKCancel.

Component : wd240obj.dll