OpenPopupPosition (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Window management functions

OpenPopupPosition

Presentation

Example

Characteristics of the popup window

Parameters passed to the window to open

Which opening mode to choose?

Limits

See also

OpenPopupPosition (Function)

In french: OuvrePopupPosition

Opens a popup window by specifying its opening position and waits until it is 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 = OpenPopupPosition(WIN_ColorSelectionWin, poBottom + poRight + poAccordingToControl, ...
BTN_ActionColor, CurrentColor)
// If a color was selected
// (MyColor <= 0 if the window is canceled)
IF MyColor > 0 THEN
// Keep the new selected color
CurrentColor = MyColor
// Change the color of the button rectangle
BTN_Color.Caption = gRectangle(0, 0, 72, 16, CurrentColor, 0)
END

Syntax

<Result> = OpenPopupPosition(<Window name> , <Opening mode> [, <Control 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 the RESULT keyword found in the closing code of the window,
by Close,
by ReturnedValue used before closing the window.

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

Name of window to open.

<Opening mode>: Combination of constants

Specify the position and the opening mode of the popup window. These constants are as follows:
poBottom The popup window will be opened below the calling control
poRight The left border of the popup window will be aligned with the left control border. The popup window stretches to the right.
poLeft The right border of the popup window will be aligned with the right border of the control. The popup window stretches to the left.
poTop The popup window will be opened above the calling control
poFixedPosition Disables the automatic positioning if the popup window may not be entirely visible on the screen
poAccordingToControl Opens the popup window according to the position of a control other than the calling control. In this case:
the control name must be specified (<Control name>).
the control name will be automatically retrieved by MyPopupControl.

<Control name>: Optional character string

Name of the control under which the popup window must be opened. This parameter must be specified only if the poAccordingToControl constant was used.

<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 the RESULT keyword found in the closing code of the window,
- by Close,
- by ReturnedValue used before closing the window.
The style of popup windows is applied to the window opened by OpenPopupPosition. 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 OpenPopupPosition. 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. Simply write the following line of code at the start:

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

See Window with parameters for more details.

Which opening mode to choose?

Remarks:

if you use only the poBottom constant, the popup window will be opened at position poRight + poBottom.
if you use only the poBottom constant, the popup window will be opened at position poRight + poTop.

Limits

OpenPopupPosition must be run from the code of a control.
The control from which OpenPopupPosition 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.

Component : wd260obj.dll