PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

  • Overview
  • Passing parameters to a window when it is opened
  • Returning a value when a window is closed
  • Running the test of a window with parameters
  • Notes
  • Parameters passed by value
  • Giving a default value to the parameter in the declaration
  • Scope of parameters
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Window with parameters
Overview
A window can:
  • Receive parameters when it is opened.
  • Return values when it is closed.
This window behaves like a procedure that may (or may not) return values.
This type of window can be useful in the following cases:
  • "calendar" windows (fix a default date when it is opened and return a selected date when it is closed),
  • search windows,
  • login windows that return the password entered, ...
This help page presents:
Versions 15 and later
WINDEV MobileAndroid The windows with parameters are available for the Android applications.
New in version 15
WINDEV MobileAndroid The windows with parameters are available for the Android applications.
WINDEV MobileAndroid The windows with parameters are available for the Android applications.
Versions 16 and later
WINDEV MobileUniversal Windows 10 App The windows with parameters are available for the Windows Phone applications.
WINDEVLinux The windows with parameters are available for the WINDEV applications in Linux.
New in version 16
WINDEV MobileUniversal Windows 10 App The windows with parameters are available for the Windows Phone applications.
WINDEVLinux The windows with parameters are available for the WINDEV applications in Linux.
WINDEV MobileUniversal Windows 10 App The windows with parameters are available for the Windows Phone applications.
WINDEVLinux The windows with parameters are available for the WINDEV applications in Linux.
Versions 17 and later
WINDEV MobileiPhone/iPad The windows with parameters are available for the iPhone/iPad applications.
New in version 17
WINDEV MobileiPhone/iPad The windows with parameters are available for the iPhone/iPad applications.
WINDEV MobileiPhone/iPad The windows with parameters are available for the iPhone/iPad applications.
Versions 21 and later
WINDEVWINDEV MobileUniversal Windows 10 App This feature is now available in Universal Windows 10 App mode.
New in version 21
WINDEVWINDEV MobileUniversal Windows 10 App This feature is now available in Universal Windows 10 App mode.
WINDEVWINDEV MobileUniversal Windows 10 App This feature is now available in Universal Windows 10 App mode.
Passing parameters to a window when it is opened
To pass parameters to a window when it is opened:
1. Declare a procedure in the "Global declarations" process of the window. The name of this procedure and the name of the window must be identical. The parameters of this procedure correspond to the parameters that must be passed to the window.
Caution: The declaration of the procedure (PROCEDURE keyword) must correspond to the first line of the "Declaration process of global variables".
For example, the WIN_CALENDAR window is used to manage the selection of a date in a calendar. This window expects a parameter indicating the date to select.
// -- Global declarations of WIN_Calendar

PROCEDURE WIN_Calendar (sSelDate)
//  sSelDate: date to select
This parameter can be handled from any process of the window (button, local procedures, ...).
For example, in the "Initialization" process of the WIN_Calendar window:
// -- Initialization of WIN_Calendar

// EDT_DateControl is an edit control
// It contains the value of the sSelDate parameter
EDT_DateControl = sSelDate
2. Pass the parameter expected by the window when it is opened (Open, OpenChild, OpenSister, MDIOpen). For example, the BTN_Calendar button is used to open the WIN_Calendar window. Today's date is passed in parameter when this window is opened.2. Pass the parameter expected by the window when it is opened (Open, OpenMobileWindow, OpenChild, OpenSister, MDIOpen). For example, the BTN_Calendar button is used to open the WIN_Calendar window. Today's date is passed in parameter when this window is opened.
// -- Click code of BTN_Calendar button

// Open the WIN_Calendar window
// Today's date is passed in parameter
Open(WIN_Calendar, Today())
Returning a value when a window is closed
To return a value when a window is closed:
1. Use ..ReturnedValue in the processes that call Close.
For example, in the WIN_Calendar window, the BTN_OK button and the BTN_CANCEL button close the window once the value to return was initialized:
// -- Click on BTN_OK button (WIN_Calendar window)

// OK was clicked by the user,
// the date entered in the EDT_DateControl control is returned
MyWindow..ReturnedValue = EDT_DateControl
// Close the window
Close()
// -- Click code of BTN_CANCEL (WIN_Calendar window)

// The BTN_CANCEL button was clicked by the user,
// an empty string is returned
MyWindow..ReturnedValue = ""
// Close the window
Close()
You also have the ability to use ..ReturnedValue in the "Closing" process of the window:
// -- Closing code of WIN_Calendar window

// The date is entered in the EDT_DateControl control
IF EDT_DateControl = "" THEN
// No date was entered
MyWindow..ReturnedValue = ""
ELSE
// A date is entered
MyWindow..ReturnedValue = EDT_DateControl
END
2. Retrieve in a variable the value returned by the window when it was closed. This variable contains the result of Open.
For example, the BTN_Calendar button is used to open the WIN_Calendar window. When opening this window (Open), today's date is passed in parameter. The value returned by the window when it is closed corresponds to the result sent by Open. This result is retrieved in the ResultDate variable:
// -- Click code of BTN_Calendar button

// Open the WIN_Calendar window
// ResultDate is a string variable containing
// the value returned by the WIN_Calendar window
ResultDate = Open(WIN_Calendar, Today())

// Study the result returned by the window
IF ResultDate = "" THEN
Info("No date was selected.")
ELSE
Info("Selected date: " + DateToString(ResultDate, maskSystemDate))
END
The process of the BTN_CALENDAR button is stopped until the WIN_Calendar window is closed.
Versions 18 and later
AndroidiPhone/iPadUniversal Windows 10 App Special case: Value returned by a child window in a WINDEV Mobile application
In the mobile applications, the windows are opened by OpenChild (instead of Open).
You can find out the value returned by a child window in the "Closing a child window" process of the window that opened the child window (the one that called OpenChild).
In the mobile applications, the windows are opened by OpenMobileWindow (or OpenChild) instead of Open.
You can find out the value returned by a child window in the "Closing a child window" process of the window that opened the child window (the one that called OpenMobileWindow or OpenChild).
For example:
  • In the closing code of the child window, Close is used to return a parameter:
    Close("", MyParameter)
  • In the "Closing of a child window" process of the calling window, the name of the child window as well as the returned value can be retrieved by using the MyChildWindow keyword:
    // Close a child window
    NameChildWindow = MyChildWindow..Name
    ValueChildWindow = MyChildWindow..ReturnedValue
New in version 18
AndroidiPhone/iPadUniversal Windows 10 App Special case: Value returned by a child window in a WINDEV Mobile application
In the mobile applications, the windows are opened by OpenChild (instead of Open).
You can find out the value returned by a child window in the "Closing a child window" process of the window that opened the child window (the one that called OpenChild).
In the mobile applications, the windows are opened by OpenMobileWindow (or OpenChild) instead of Open.
You can find out the value returned by a child window in the "Closing a child window" process of the window that opened the child window (the one that called OpenMobileWindow or OpenChild).
For example:
  • In the closing code of the child window, Close is used to return a parameter:
    Close("", MyParameter)
  • In the "Closing of a child window" process of the calling window, the name of the child window as well as the returned value can be retrieved by using the MyChildWindow keyword:
    // Close a child window
    NameChildWindow = MyChildWindow..Name
    ValueChildWindow = MyChildWindow..ReturnedValue
AndroidiPhone/iPadUniversal Windows 10 App Special case: Value returned by a child window in a WINDEV Mobile application
In the mobile applications, the windows are opened by OpenChild (instead of Open).
You can find out the value returned by a child window in the "Closing a child window" process of the window that opened the child window (the one that called OpenChild).
In the mobile applications, the windows are opened by OpenMobileWindow (or OpenChild) instead of Open.
You can find out the value returned by a child window in the "Closing a child window" process of the window that opened the child window (the one that called OpenMobileWindow or OpenChild).
For example:
  • In the closing code of the child window, Close is used to return a parameter:
    Close("", MyParameter)
  • In the "Closing of a child window" process of the calling window, the name of the child window as well as the returned value can be retrieved by using the MyChildWindow keyword:
    // Close a child window
    NameChildWindow = MyChildWindow..Name
    ValueChildWindow = MyChildWindow..ReturnedValue
Running the test of a window with parameters
To run the test of a window with parameters:
  1. Open the window with parameters in the window editor ("File .. Open").Open the window with parameters in the window editor: on the "Home" pane, in the "General" group, click "Open".
  2. Click the "Go" icon in the icon bar of WINDEV (or press [F9]). The following window is displayed:Click among the quick access buttons (or press [F9]). The following window is displayed:
  3. Specify the value of the parameters that will be used to run the test of the window. To use the default value of the parameters, type the "*" character.
  4. Validate. The window is displayed according to the specified values.
Notes

Parameters passed by value

If the parameters passed to a window are modified in this window, these modifications will be taken into account in this window only. The value of these parameters is not modified in the calling process.
For example:
  1. The MyDate variable is declared in the code of the BTN_Calendar button. This variable contains today's date (for example: MyDate = Today()).
  2. This variable is passed in parameter to the WIN_Calendar window. The sSelDate parameter contains the value of the MyDate variable.
  3. The value of the sSelDate parameter is modified in the WIN_Calendar window (for example: sSelDate = "20020701").
  4. The value of the MyDate variable is not modified.

Giving a default value to the parameter in the declaration

A default value can be given to the parameters when declaring the parameters.
For example, to give a default value in the previous example, enter the following code in the "Global declarations" process of the WIN_Calendar window:
// -- Global declarations of WIN_Calendar

PROCEDURE WIN_Calendar(sSelDate = "20030101")
//  sSelDate: date to select

Scope of parameters

The parameters passed to a window are global to all the processes of this window (initialization, code of a button, code of a local procedure, ...).
See also
Minimum required version
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment