ReturnedValue (Property)

Find out and modify the value returned by a window or by a page.Find out and modify the value returned by a window, a page or a report.
Find out and modify the value returned by an option in a Radio Button control.

Reminder: A window opened by Open may return a result 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.

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

by the Result keyword found in the closing code of the page,
by PageCloseDialog,
by ..ReturnedValue used before closing the page,
by ContextClose.

Versions 18 and later

Used on the MyChildWindow keyword, ..ReturnedValue allows you to retrieve the value returned by a child window in a mobile application.

New in version 18

Used on the MyChildWindow keyword, ..ReturnedValue allows you to retrieve the value returned by a child window in a mobile application.

Versions 19 and later

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

by the Result keyword found in the closing code of the report,
by ..ReturnedValue used before closing the report.

New in version 19

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

by the Result keyword found in the closing code of the report,
by ..ReturnedValue used before closing the report.

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

by the Result keyword found in the closing code of the report,
by ..ReturnedValue used before closing the report.

Versions 24 and later

..ReturnedValue allows you to know and modify the value returned by a popup used by a Popup Combo Box.

New in version 24

..ReturnedValue allows you to know and modify the value returned by a popup used by a Popup Combo Box.

Versions 16 and later

This property is now available for the Windows Phone applications.

New in version 16

This property is now available for the Windows Phone applications.

Versions 15 and later

This property is now available for the Android applications.

New in version 15

This property is now available for the Android applications.

Versions 17 and later

This property is now available for the iPhone/iPad applications.

New in version 17

This property is now available for the iPhone/iPad applications.

Versions 18 and later

This property is now available in Windows Store Apps mode.

This property is now available in Android Widget mode.

New in version 18

This property is now available in Windows Store Apps mode.

This property is now available in Android Widget mode.

This property is now available in Windows Store Apps mode.

This property is now available in Android Widget mode.

Versions 20 and later

This property is now available:

for the reports,
for the internal reports (read-only).

New in version 20

This property is now available:

for the reports,
for the internal reports (read-only).

This property is now available:

for the reports,
for the internal reports (read-only).

Versions 21 and later

This property is now available in Universal Windows 10 App mode.

New in version 21

This property is now available in Universal Windows 10 App mode.

Versions 24 and later

This function is now available in browser code.

New in version 24

This function is now available in browser code.

Example

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

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

// -- Click code on "OK" button in the "WIN_EditPassword" window
// 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

Versions 18 and later

// Event "Closing 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
nSubscript is int
// Finds the customer row
nSubscript = LooperSeek(ATT_CustomerNum, Customer.CustomerNum)
IF nSubscript > 0 THEN
// Positions on the customer row
LooperPosition(LOOP_Customers, nSubscript)
END
END

New in version 18

Syntax

Finding out the returned value Hide the details

<Result> = <Element name>..ReturnedValue

<Result>: Any type

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

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

Name of element used:
Name of the window or page used. This window or page must be opened.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: <Name of Radio Button>[<Option number>].

Modifying the returned value Hide the details

<Element name>..ReturnedValue = <New value>

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

Name of element used:
Name of the window or page used. This window or page must be opened.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: <Name of Radio Button>[<Option number>].

<New value>: Any type

New value to return.
Versions 15 and later
From version 15, the following types can be used:
structure
dynamic structure
class
advanced type
array
associative array
queue
stack
list
New in version 15
From version 15, the following types can be used:
structure
dynamic structure
class
advanced type
array
associative array
queue
stack
list
From version 15, the following types can be used:
structure
dynamic structure
class
advanced type
array
associative array
queue
stack
list

Remarks

Versions 18 and later

Finding out the value returned by a child window

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

It is possible to know the value returned by a child window in the event "Closing a child window" of the window that opened it (the one that called OpenChild).

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

It is possible to know the value returned by a child window in the event "Closing a child window" 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 event "Closing a child window" of the calling window, using the MyChildWindow keyword:

// Close a child window
NameChildWindow = MyChildWindow..Name
ValueChildWindow = MyChildWindow..ReturnedValue

New in version 18

Finding out the value returned by a child window

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

It is possible to know the value returned by a child window in the event "Closing a child window" of the window that opened it (the one that called OpenChild).

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

It is possible to know the value returned by a child window in the event "Closing a child window" 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 event "Closing a child window" of the calling window, using the MyChildWindow keyword:

// Close a child window
NameChildWindow = MyChildWindow..Name
ValueChildWindow = MyChildWindow..ReturnedValue

Finding out the value returned by a child window

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

It is possible to know the value returned by a child window in the event "Closing a child window" of the window that opened it (the one that called OpenChild).

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

It is possible to know the value returned by a child window in the event "Closing a child window" 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 event "Closing a child window" of the calling window, using the MyChildWindow keyword:

// Close a child window
NameChildWindow = MyChildWindow..Name
ValueChildWindow = MyChildWindow..ReturnedValue

Limits

..ReturnedValue applies to:

the windows,
the pages,
the options found in the Radio Button controls.
Versions 19 and later
the internal windows only if they are opened by Open.
New in version 19
the internal windows only if they are opened by Open.
the internal windows only if they are opened by Open.
Versions 20 and later
the reports.
New in version 20
the reports.
the reports.
Versions 20 and later
the internal reports (in read-only).
New in version 20
the internal reports (in read-only).
the internal reports (in read-only).
Versions 24 and later
the popups used via a Popup Combo Box control.
New in version 24
the popups used via a Popup Combo Box control.
the 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.