StoredValue (Property)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

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

Limitations

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

StoredValue (Property)

In french: ValeurMémorisée

The StoredValue property is used to get the value currently stored by:

a row in a List Box, ListView or Combo Box control.
a "Text token" Edit control.
a row of a Table control.
New in version 28
an input suggestion in an Edit control (if the suggestion is selected).

The currently stored value can correspond to:

for List Box, ListView, and Combo Box controls based on a data file: the value of the stored item defined in the window editor ("Content" tab of the control description):
.
for List Box, ListView, and Combo Box controls populated programmatically: the value defined by gStoredValue.
Reminder: To retrieve the value defined by gStoredValue:
- use the gStoredValueEnable function.
- check "Return value specified with gStoredValue" ("Details" tab of the control description).
Remark: This property can be used to retrieve the stored values from a multi-selection List Box.
for "Text token" Edit controls: the value of the token.
for a row of a Table control populated programmatically: the stored value of the row. For this type of control, you can also assign the stored value of the row.
for a row of a Table control based on a variable, populated by an array of structures: a structure of the array.
New in version 28
for an input suggestion in an Edit control: the stored value associated with the suggestion. This value is defined when the suggestion is added with the AssistedInputAdd function, or with a variable of type AssistedInput.

New in version 28

This property is now available in browser code for List Box and Combo Box controls only.

Example

// Values selected in a multi-selection List Box control
i is int = 1
iSelectedRow is int
iSelectedRow = ListSelect(LIST_Cedex, 1)
WHILE iSelectedRow <> -1
Trace(LIST_Cedex[iSelectedRow].StoredValue)
i++
iSelectedRow = ListSelect(LIST_Cedex, i)
END

// Get the stored value when selecting the 3rd element of the List Box control
Info("The stored value is " + LIST_Cedex[3].StoredValue)

// Find out the value stored by the "Text token" Edit control
Info("The stored value is " + EDT_Token.StoredValue)
// Returns for example:
// TOKEN_ADDED+CR+TOKEN_ADDED2

New in version 28

AssistedInputAdd(EDT_Edit1, "Displayed value", "Stored value")

// "Select a value in the list of input suggestions" event
// ----------------------------------------------------
PROCÉDURE Selection(MySelection is AssistedInput)
Trace(MySelection.StoredValue)
// Returns "stored value"

Syntax

Getting the stored value of a List Box, ListView or Combo Box control Hide the details

<Stored value> = <Control used>[<Element index>].StoredValue

<Stored value>: Character string

Value that will be stored if the user selects the element in the specified control.

<Control used>: Control name

Name of the List Box, ListView or Combo Box control to use.

<Element index>: Integer

Index of the element in the control (List Box, ListView or Combo Box) whose stored value is requested.

Getting the value stored in a "Text token" Edit control Hide the details

<Stored value> = <Edit control>.StoredValue

<Stored value>: Character string

Stored value. If the control has several tokens, this parameter will have the following syntax:

<Value of Token 1> + CR + ... + <Value of Token N>

<Edit control>: Control name

Name of the "Text token" Edit control to use.

Not available in browser code

Getting the stored value of a row of a Table control Hide the details

<Stored value> = <Table control>[<Row index>].StoredValue

<Stored value>: Character string

Stored value for the row.

<Table control>: Control name

Name of the Table control to be used.

<Row index>: Integer

Index of the row whose value is requested.

New in version 28

Not available in browser code

Getting the stored value of an input suggestion Hide the details

<Stored value> = <Element>.StoredValue

<Stored value>: Character string

Stored value for the row.

<Element>: AssistedInput variable or control name

AssistedInput variable containing the characteristics of the selected row.
When used in the "Select a value in the list of input suggestions" event, this variable contains the characteristics of the selected suggestion.
Name of the Edit control in which the row was selected.

Remarks

Limitations

The StoredValue property applies only to:

List Box, ListView and Combo Box controls.
"Text token" Edit controls.
New in version 28
Edit controls with input suggestions.
the Table controls.

The StoredValue property applies only to:

List Box and Combo Box controls.
New in version 28
Edit controls with input suggestions.

The StoredValue property can only be used with the following elements:

Combo Box controls and rows of Combo Box controls.
ListView controls and rows of ListView controls.
Group of controls.

New in version 28

The StoredValue property can only be used with the following elements:

Combo Box controls and rows of Combo Box controls.
ListView controls and rows of ListView controls.

The StoredValue property applies only to:

List Box controls.
New in version 28
Edit controls with input suggestions.