OpenPopupPosition (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 / Controls, pages and windows / Window functions

Characteristics of the popup window
Parameters passed to the window to open
Which opening mode to choose?
Limitations

WINDEV

WEBDEV

WINDEV Mobile

Others

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

// Ouverture d'une fenêtre de sélection de couleur
MaCouleur is int 
MaCouleur = OpenPopupPosition(FEN_CouleurFenSélecteur, popBelow + popAlignedRight + ...
	popAccordingToControl, BTN_CouleurAction, CouleurCourante)
// Si une couleur a été sélectionnée 
// (MaCouleur <= 0 si on annule la fenêtre)
IF MaCouleur > 0 THEN
	// On conserve la nouvelle couleur sélectionnée
	CouleurCourante = MaCouleur
	// Changement de couleur du rectangle du champ Bouton
	BTN_Couleur.Libellé = gRectangle(0, 0, 72, 16, CouleurCourante, 0)
END

Syntax

<Result> = OpenPopupPosition(<Popup window> , <Opening mode> [, <Reference control>] [, <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 RETURN keyword in the window closing code,
by the Close function,
by the ReturnedValue property used before closing the window.

<Popup window>: Window name

Name of the window to be opened.

<Opening mode>: Combination of constants

Specify the position and the opening mode of the popup window. These constants are:
popAbove The popup window will be opened above the calling control.
(Corresponds to the poTop constant in previous versions).
popAccordingToControl 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.
(Corresponds to the poAccordingToControl constant in previous versions).
popAlignedLeft The left border of the popup window will be aligned with the left control border. The popup window stretches to the right.
(Corresponds to the poRight constant in previous versions).
popAlignedRight The right border of the popup window will be aligned with the right border of the control. The popup window stretches to the left.
(Corresponds to the poLeft constant in previous versions).
popBelow The popup window will be opened below the calling control.
(Corresponds to the poBottom constant in previous versions).
popCenteredHorizontally The popup window is centered horizontally with the calling control.
popCenteredWindow The popup window is centered relative to the parent window.
popDefault
(Default value) By default, the popAlignedLeft + popBelow constants are used.
popDisableAutoRepositioning Disables automatic repositioning if the popup window is likely to be truncated.
(Corresponds to the poFixedPosition constant in previous versions).

<Reference control>: Optional control name

Name of the control under which the popup window must be opened. This parameter must only be specified if the poSelonChamp constant has been 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 RETURN keyword in the window closing code,
- by the Close function,
- by the ReturnedValue property used before closing the window.
The style of the 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 calls OpenPopupPosition. If there isn't enough room to open the window, it will either open above the field, or below the field to the left.

Parameters passed to the window to open

The parameters are retrieved in the "Global declarations" event of the window. Simply write the following line of code at the start:

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

For more details, see Window with parameters.

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.

Limitations

OpenPopupPosition must be executed from the code of a control.
The control that calls OpenPopupPosition must be visible.
Non-modal windows 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 another popup window.

Business / UI classification: UI Code

Component: wd300obj.dll