ReturnedValue (Property)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage properties / Properties associated with windows, pages and controls

Finding out the value returned by a child window
Limitations

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

ReturnedValue (Property)

In french: ValeurRenvoyée

The ReturnedValue property is used to:

Get and change the value returned by a window, page or report.
Get and change the value returned by an option in a Radio Button control.

Reminder: A window opened by Open may return a result when closed. This value is returned:

by the Return keyword in the window closing code,
by the Close function,
Remark: Close returns multiple values.
by the ReturnedValue property used before closing the window.

Reminder: A page opened by PageDisplayDialog may return a result when closed. This value is returned:

by the Return keyword in the page closing code,
by the PageCloseDialog function,
by the ReturnedValue property used before closing the page,
by the ContextClose function.

Used on the MyChildWindow keyword, the ReturnedValue property is used to get the value returned by a child window in a mobile application.

Reminder: A report printed by iPrintReport may return a result at the end of the print job. This value is returned:

by the Return keyword in the report closing code,
by the ReturnedValue property used before closing the report.

The ReturnedValue property is used to get and change the value returned by a popup in a Combo Box Popup control.

Example

// Code used to open the "WIN_EditPassword" window
MyPassword = Open(WIN_EditPassword)
IF MyPassword <> "" THEN
Info("Wrong password")
END

// --------------------------------------------------------------------------------
// -- Click code on the "OK" Button control in "WIN_EditPassword"
// The user types his password in the "EDT_Password" control
// and validates the window
Close()

// --------------------------------------------------------------------------------

// -- Closing code of the window
WIN_EditPassword.ReturnedValue = EDT_Password

// Event "Close a child window of WIN_List_Customers"
// -------------------------------------------------------------
// Refreshes the list of customers
LooperDisplay(LOOP_Customers, taReExecuteQuery)

// For any return (except for the deletion)
IF MyChildWindow.ReturnedValue <> -1 THEN
nIndex is int
// Finds the customer row
nIndex = LooperSearch(ATT_CustomerNum, Customer.CustomerNum)
IF nIndex > 0 THEN
// Positions on the customer row
LooperPosition(LOOP_Customers, nIndex)
END
END

Syntax

Finding out the returned value Hide the details

<Result> = <Element used>.ReturnedValue

<Result>: Any type

Value that will be returned:
when closing the current window, page or report.
if the option is selected in the radio button.

<Element used>: Name of window, page, report, option

Name of element used:
Name of the window, page, report or internal report used. This window, page or report must be opened.
Name of the option in the radio button. This name has the following format: <Radio Button control>[<Option number>].

Modifying the returned value Hide the details

<Element used>.ReturnedValue = <New value>

<Element used>: Name of window, page, report, option

Name of element used:
Name of the window, page or report used. This window, page or report must be opened.
Name of the option in the radio button. This name has the following format: <Radio Button control>[<Option number>].

<New value>: Any type

New value to return. The following types can be used:
structure
dynamic structure
class
advanced type
array
associative array
queue
stack
list

Remarks

Finding out the value returned by a child window

In the mobile applications, the windows are opened by OpenMobileWindow (or OpenChild) instead of Open.

You can get the value returned by a child window in the "Close a child window" event of the window that opened it (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)
The name of the child window as well as the returned value can be retrieved in the "Close a child window" event of the calling window, using the MyChildWindow keyword:
// Close a child window
NameChildWindow = MyChildWindow.Name
ValueChildWindow = MyChildWindow.ReturnedValue

Limitations

The ReturnedValue property applies to:

windows,
pages,
options in Radio Button controls.
internal windows only if they are opened with Open.
reports.
internal reports (in read-only).
popups used via a Popup Combo Box control.

Related Examples:

Unit examples (WINDEV): Popup calendar

[ + ] Using a calendar that can be used by the OpenPopup function.
The PopCalendar window is very useful in the applications containing date controls.
Indeed, the PopCalendar window allows you to choose a date visually.
The risk of error is reduced as the user can see the day of the week corresponding to the selected date.
Then, the date control is filled with the value returned by the PopCalendar window.