OpenPopup (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Window management functions

OpenPopup

Presentation

Example

Characteristics of the popup window

Parameters passed to the window to open

Constants for managing the windows

Constants for object visibility

ExecuteRefreshUIParent

FullScreen

Functions for managing windows

RequestRefreshUIParent

WinGiveSuitableHeight

Characteristics of the popup window
Parameters passed to the window to open
Limits

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

OpenPopup (Function)

In french: OuvrePopup

Opens a popup window and waits for this window to be closed. This function must be used in the code of a control (click code of button for example).

Example

// Open the window for color selection
MyColor is int
MyColor = OpenPopup(WIN_ColorWinSelection)
// If a color was selected
// (nColor <= 0 if the window is canceled)
IF MyColor > 0 THEN
// Change the color of the button rectangle
BTN_Color..Caption = gRectangle(0, 0, 72, 16, MyColor, 0)
END

Syntax

<Result> = OpenPopup(<Window name> [, <Parameter 1> [... [, <Parameter N>]]])

<Result>: Type corresponding to the retrieved value (optional)

Value returned by the popup window when it is closed. This value is returned:
by RESULT used in the "Closing" event associated with the window,
by Close,
by ..ReturnedValue used before closing the window.

<Window name>: Character string (with or without quotes)

Name of window to open.

<Parameter 1>: Type of value sent to the window (optional)

First parameter that will be passed to the "Global declarations" event of the window to open. These parameters are passed by reference and are considered as global variables to the window.

<Parameter N>: Type of value sent to the window (optional)

Nth parameter that must be passed to the "Global declarations" event of the window to open. These parameters are passed by reference and are considered as global variables to the window.

Remarks

Characteristics of the popup window

The window is automatically closed when it loses focus or during the call to Close. The current value is returned to the control that opened the popup window by one of the following methods:
- by RESULT used in the "Closing" event associated with the window,
- by Close,
- by ..ReturnedValue used before closing the window.
The style of popup windows is applied to the window opened by OpenPopup. If a title bar was defined in the editor, this title bar is reduced and the window cannot be maximized or minimized.
The popup window is opened below the control that is running OpenPopup. If there is not enough space to open the window, the window will be opened either above the control, or below the control to the left.

Parameters passed to the window to open

The parameters are retrieved in the event "Global declarations" of the window. The first line of code of this event must correspond to the following line:

PROCEDURE <Window name> (<Parameter1> [, <Parameter2> [, ...]])

See Window with parameters for more details.

Limits

OpenPopup must be run from the code of a control.
The control from which OpenPopup is run must be visible.
A window that is not a modal window cannot be opened from a popup window. Open must be used to open a window. Opening a modal window from a popup window does not automatically close the popup window. In this case, you must process the return value of Open and you must use Close to close the popup window.
A popup window cannot be opened from a popup window.

Related Examples:

Unit examples (WINDEV Mobile): Popup calendar

[ + ] Implementing a calendar popup for date selection.

Component : wd260obj.dll