Value (Property)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Value of Static control

Value of Calculated control in a report

Value of Bar Code control

Value of Image control

Value of Item control or preset control found in a report

Value of Static control or preset control found in a report

Value of RTF control

Value of window or page

Value of edit control

Value of Button control

Value of Check Box control or value of option in a Check Box control

Value of Radio Button control

Value of List Box, ListView or Table control

Value of cell in a Table control

Value of Combo Box control

Value of TreeView control or TreeView Table control

Value of a Progress Bar, Slider, Spin or Scrollbar control

Value of Tab control

Value of menu or menu option

Value of Chart control

Value of OLE control

Value of Rating control

Value of Drawer control

Value of ActiveX control

Value of HTML control

Value of Map control

Value of stream

Value of Spreadsheet control

Limits

See also

Value (Property)

In french: Valeur

..Value is used to:

Find out and modify the value of a report control.
Find out and modify the value of a control or the title of a window.
Find out the identifier of a stream.
Find out and modify the value of a control or the title of a page.
Center the map found in a Map control on a specific position.
Versions 18 and later
Find out the value associated with a value of an Enumeration variable.
New in version 18
Find out the value associated with a value of an Enumeration variable.
Find out the value associated with a value of an Enumeration variable.
Versions 23 and later
Find out the identifier or the handle associated with a Native Container control.
New in version 23
Find out the identifier or the handle associated with a Native Container control.
Find out the identifier or the handle associated with a Native Container control.

Remark: ..Value is rarely used and it can be replaced by an equivalent syntax (see Notes).

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 18 and later

This property is now available in Windows Store Apps mode.

New in version 18

This property is now available in Windows Store Apps mode.

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.

Example

// Modify the image file associated with the "IMG_Image" control
IMG_Image..Value = "C:\MyImages\Image.BMP"

Syntax

Finding out the value of an element Hide the details

<Result> = <Element name>..Value

<Result>: Any type

This result depends on the element type.

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

Name of element to use.

Modifying the value of an element Hide the details

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

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

Name of element to use.

<New value>: Any type

New value for the specified element. This parameter depends on the type of specified element.

Remarks

Value of Static control

..Value is used to find out and modify the text of a Static control.

<Result> is a character string.

To retrieve the text of a Static control, the following syntaxes are equivalent:

ResCaption = <Name of Static control>..Value
ResCaption = <Name of Static control>
ResCaption = <Name of Static control>..Caption

Value of Calculated control in a report

..Value is used to find out and modify the value of a Calculated control in a report.

The type of <Result> depends on the type of the Calculated control.

To retrieve the value of a Calculated control, use one of the following syntaxes:

ResValue = <Name of Calculated control>..Value

ResValue = <Name of Calculated control>

Value of Bar Code control

..Value is used to find out and modify the value of a Bar Code control. The value of a Bar Code control corresponds to the character string represented in the bar code.

<Result> is a character string.

To retrieve the text of a Bar Code control, use one of the following syntaxes:

ResValue = <Name of Bar Code control>..Value

ResValue = <Name of Bar Code control>

Value of Image control

..Value is used to find out and modify the image file associated with an Image control.

<Result> is a character string containing the path of the image file.

To find out the image file associated with an Image control, use one of the following syntaxes:

ResImage = <Name of Image control>..Value

ResImage = <Name of Image control>

Value of Item control or preset control found in a report

Value of Static control or preset control found in a report

..Value is used to find out and modify the content of the control.

In assignment, the type of the value passed to ..Value depends on the type of the item associated with the control.

If the item is a numeric item, you must assign a number to it and check whether the input mask is suitable (..InputMask).

For a Date control, a date must be assigned to it.

Value of RTF control

..Value is used to find out and modify the content of an RTF control. The value contains the special characters specific to the RTF format.

<Result> is a character string.

To retrieve the content of an RTF control, use one of the following syntaxes:

ResRTF = <Name of RTF control>..Value

ResRTF = <Name of RTF control>

Value of window or page

..Value is used to find out and modify the title of a window or page.

<Result> is a character string.

..Value is equivalent to ..Title.

To find out the title of a window or the title of a page, use one of the following syntaxes:

ResTitle = <Name of window or page>..Value

ResTitle = <Name of window or page>

ResTitle = <Name of window or page>..Title

Value of edit control

..Value is used to find out and modify the value typed in an edit control.

<Result> has the following type:

character string if the sub-type of edit control corresponds to "Text", "Date" or "Time",
integer or real if the sub-type of the edit control corresponds to "Numeric",
numeric if the sub-type of the edit control corresponds to "Currency" or "Currency + Euro".

To find out the value typed in an edit control, use one of the following syntaxes:

ResValue = <Name of Edit control>..Value

ResValue = <Name of Edit control>

Value of Button control

..Value is used to retrieve and modify the text of a Button control.

If the Button control contains an image, only the text is returned. It is not possible to assign a drawing to a Button control.

<Result> is a character string.

..Value is equivalent to ..Caption.

To know the text of a Button control, use one of the following syntaxes:

ResButton = <Name of Button control>..Value

ResButton = <Name of Button control>

ResButton = <Name of Button control>..Caption

Value of Check Box control or value of option in a Check Box control

..Value is used to:

Check or uncheck an option in a Check Box control.
Find out whether an option found in a Check Box control is checked or unchecked

<Result> is a boolean:

True if the option is checked,
False otherwise.

To find out whether an option found in a Check Box control is checked or not, use one of the following syntaxes:

ResChecked = <Name of Check Box control>[<Option number>]..Value

ResChecked = <Name of Check Box control>[<Option number>]

ResChecked = <Option name>..Value

ResChecked = <Option name>

Remark: If <Option number> is not specified, the first option is selected by default.

Value of Radio Button control

..Value is used to:

Find out the active option in a Radio Button control.
Select an option.

<Result> is an integer.

To find out the active option in a Radio Button control, use one of the following syntaxes:

ResOption = <Name of Radio Button control>..Value

ResOption = <Name of Radio Button control>

Remark: A Radio Button control is always positioned on a position (1 by default). To display a Radio Button control with no default option, all you have to do is assign -1 to the control value during its initialization:

// Initialize the value of "RADIO_Customer" with its initial value
RADIO_Customer..InitialValue = -1

Value of List Box, ListView or Table control

Two distinct cases may occur.

The List Box (ListView or Table) control is a memory control OR ..StoredItem corresponds to an empty string ("").
..Value is used to:
- Find out the selected row. If no row is selected, ..Value returns -1. If the control allows for multiselection, the number of the last selected row is returned.
  To find out the selected row, use one of the following syntaxes:
  
  ResRow = <Control name>..Value
  
  ResRow = <Control name>
- Move the selection by specifying the number of the new row to select. The rows that were selected beforehand are deselected.
The List Box (ListView or Table) control is a browsing control AND ..StoredItem is not empty.
..Value is used to find out the stored item for the record associated with the selected row. If no row is selected, ..Value returns an empty string ("").
To find out the stored item associated with the selected row, use one of the following syntaxes:

ResStoredItem = <Control name>..Value

ResStoredItem = <Control name>..StoredItem

Value of cell in a Table control

..Value is used to find out and modify the value of a cell in a Table control.

<Result> is a character string.

To find out the value of a cell, use one of the following syntaxes:

ResCell = <Name of Table control>[<Row number>][<Column number>]..Value

ResCell = <Name of Table control>[<Row number>][<Column number>]

ResCell = <Column name>[<Row number>]..Value

ResCell = <Column name>[<Row number>]

Special case: Value of cell in the current row
If only the name of the column is specified, ..Value is used to:

Find out the value of the cell identified by the specified column and by the current row in the Table control. If there is no current row, an empty string ("") is returned.
Modify the value of the cell identified by the specified column and by the current row in the Table control.

<Result> is a character string.

To find out the value of the cell identified by the specified column and by the current row in the Table control, use one of the following syntaxes:

ResColumn = <Column name>..Value

ResColumn = <Column name>

Value of Combo Box control

Two distinct cases may occur.

The Combo Box control is editable AND ..StoredItem corresponds to an empty string ("").
..Value is used to:
- Find out the value of selected item. If no element is selected, ..Value returns an empty string ("").
  To find out the value of the selected element, use one of the following syntaxes:
  
  ResValue = <Name of Combo Box control>..Value
  
  ResValue = <Name of Combo Box control>
- Modify the value of the selected element.
The Combo Box is not editable OR ..StoredItem is not empty.
..Value is used to find out the number of the selected element.
To find out the number of the selected element, use one of the following syntaxes:

ResElement = <Name of Combo Box control>..Value
ResElement = <Name of Combo Box control>[<Name of Combo Box control>]
ResElement = <Name of Combo Box control>

Versions 19 and later

Value of TreeView control or TreeView Table control

Two distinct cases may occur.

The control is memory control OR ..StoredItem corresponds to an empty string ("").
..Value is used to:
- Find out the selected row. If no row is selected, ..Value returns -1. If the control allows for multiselection, the number of the last selected row is returned.
  To find out the selected row, use one of the following syntaxes:
  
  ResRow = <Control name>..Value
  
  ResRow = <Control name>
- Move the selection by specifying the number of the new row to select. The rows that were selected beforehand are deselected.
The control is a browsing control AND ..StoredItem is not empty.
..Value is used to find out the stored item for the record associated with the selected row. If no row is selected, ..Value returns an empty string ("").
To find out the stored item associated with the selected row, use one of the following syntaxes:

ResStoredItem = <Control name>..Value

ResStoredItem = <Control name>..StoredItem

New in version 19

Value of TreeView control or TreeView Table control

Two distinct cases may occur.

The control is memory control OR ..StoredItem corresponds to an empty string ("").
..Value is used to:
- Find out the selected row. If no row is selected, ..Value returns -1. If the control allows for multiselection, the number of the last selected row is returned.
  To find out the selected row, use one of the following syntaxes:
  
  ResRow = <Control name>..Value
  
  ResRow = <Control name>
- Move the selection by specifying the number of the new row to select. The rows that were selected beforehand are deselected.
The control is a browsing control AND ..StoredItem is not empty.
..Value is used to find out the stored item for the record associated with the selected row. If no row is selected, ..Value returns an empty string ("").
To find out the stored item associated with the selected row, use one of the following syntaxes:

ResStoredItem = <Control name>..Value

ResStoredItem = <Control name>..StoredItem

Value of TreeView control or TreeView Table control

Two distinct cases may occur.

The control is memory control OR ..StoredItem corresponds to an empty string ("").
..Value is used to:
- Find out the selected row. If no row is selected, ..Value returns -1. If the control allows for multiselection, the number of the last selected row is returned.
  To find out the selected row, use one of the following syntaxes:
  
  ResRow = <Control name>..Value
  
  ResRow = <Control name>
- Move the selection by specifying the number of the new row to select. The rows that were selected beforehand are deselected.
The control is a browsing control AND ..StoredItem is not empty.
..Value is used to find out the stored item for the record associated with the selected row. If no row is selected, ..Value returns an empty string ("").
To find out the stored item associated with the selected row, use one of the following syntaxes:

ResStoredItem = <Control name>..Value

ResStoredItem = <Control name>..StoredItem

Value of a Progress Bar, Slider, Spin or Scrollbar control

..Value is used to find out and modify the value of a Progress Bar, Slider, Spin or Scrollbar control.

<Result> is a real.

To find out the value of a Progress Bar, Slider, Spin or Scrollbar control, use one of the following syntaxes:

ResValue = <Control name>..Value

ResValue = <Control name>

Value of Tab control

..Value is used to find out the number of the active tab pane or to enable a pane in a Tab control.

<Result> is an integer.

To find out the number of the active tab pane, use one of the following syntaxes:

ResPane = <Name of Tab control>..Value

ResPane = <Name of Tab control>

Value of menu or menu option

..Value is used to find out the number associated with the menu or with the current menu option.

Remark: The number associated with a menu or menu option is defined in the "General" tab of the description window of menu or menu option.

<Result> is an integer.

To find out the number associated with the menu or with the current menu option, use one of the following syntaxes:

ResMenu = <Name of menu or menu option>..Value

ResMenu = <Name of menu or menu option>

Value of Chart control

..Value can only be used to find out the name of a Chart control.

<Result> is a character string.

To find out the name of a Chart control, use one of the following syntaxes:

Res_ChartName = <Name of Chart control>..Value

Res_ChartName = <Name of Chart control>

Value of OLE control

..Value is used to initialize an OLE control with an OLE object (equivalent to OLELoad).

Example:

OLE_OLE1..Value = "Test.OLE" // Equivalent to OLELoad("OLE_OLE1","Test.OLE")

Value of Rating control

..Value is used to initialize and find out the value of a Rating control.

This value corresponds to the number of "pictograms" displayed in the control.

Example:

RATE_Nation1..Value = 4.5

Versions 21 and later

Remark: The value of the Rating control takes into account the value of a star defined either in the control description, or by ..ValuePerStar.

New in version 21

Remark: The value of the Rating control takes into account the value of a star defined either in the control description, or by ..ValuePerStar.

Value of Drawer control

..Value is used to find out whether the HideShow control is expanded (1) or collapsed (0) and to modify its status.

Example:

// Collapses the Drawer control if it is expanded
IF HS_Drawer1..Value = 1 THEN HS_Drawer1..Value = 0

Value of ActiveX control

..Value is used to find out the COM identifier (ProgId) of the ActiveX used.

Value of HTML control

..Value is used to find out the address associated with the HTML page displayed in the control. If the page:

is a page built in HTML directly, the value corresponds to "about:blank".
is a page from a site, the value corresponds to the address of the page (www.windev.com for example).
is an HTML file, the value corresponds to the address of the file.

..Value returns the URL of the site but it cannot return the HTML code of the control. This property cannot be used to associate a local htm file with the HTML control.

Versions 17 and later

Value of Map control

..Value is used to center the map (found in a Map control) on the position corresponding to a geoPosition variable.

Example:

// Centers the map displayed by the "MAP_Position" control on a geographical position
MyPosition is geoPosition

MAP_Position..Value = MyPosition

Remarks:

Using ..Value is equivalent to MapDisplayPosition. The only difference is: when using MapDisplayPosition, the positioning on the requested position is performed via an animation.

New in version 17

Value of Map control

..Value is used to center the map (found in a Map control) on the position corresponding to a geoPosition variable.

Example:

// Centers the map displayed by the "MAP_Position" control on a geographical position
MyPosition is geoPosition

MAP_Position..Value = MyPosition

Remarks:

Using ..Value is equivalent to MapDisplayPosition. The only difference is: when using MapDisplayPosition, the positioning on the requested position is performed via an animation.

Value of Map control

..Value is used to center the map (found in a Map control) on the position corresponding to a geoPosition variable.

Example:

// Centers the map displayed by the "MAP_Position" control on a geographical position
MyPosition is geoPosition

MAP_Position..Value = MyPosition

Remarks:

Using ..Value is equivalent to MapDisplayPosition. The only difference is: when using MapDisplayPosition, the positioning on the requested position is performed via an animation.

Value of stream

..Value is used to find out the identifier of a stream. The property can be used on the name of the stream or on the name of the Conference control associated with the stream.

Versions 20 and later

Value of Spreadsheet control

..Value is used to find out and modify the binary content of a Spreadsheet control.
For example:

PSHEET_Show..Value = fLoadBuffer(fExeDir() + "\Fashion Show.xls")

New in version 20

Value of Spreadsheet control

..Value is used to find out and modify the binary content of a Spreadsheet control.
For example:

PSHEET_Show..Value = fLoadBuffer(fExeDir() + "\Fashion Show.xls")

Value of Spreadsheet control

..Value is used to find out and modify the binary content of a Spreadsheet control.
For example:

PSHEET_Show..Value = fLoadBuffer(fExeDir() + "\Fashion Show.xls")

Limits

For the reports, ..Value cannot be used on:

a report.
a report block.
a Check Box control.
a Shape control.
an Organizer control.
a Scheduler control.
a Gantt Chart control.
Versions 21 and later
a Signature control.
New in version 21
a Signature control.
a Signature control.

a Chart control.

In a window, ..Value cannot be used on:

an option in a radio button.
a tab pane.
a group of controls.

a TreeView control.

..Value only applies to the following elements:

Button.
Static control.
Edit control.
Image.
Check Box.
Radio Button.
List Box.
Combo Box.
Tab.
Window.
Table.
Table column.
Supercontrol.