DisplayedItem (Property)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

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

Handling Table, Looper, List Box, ListView and Combo Box controls based on a data file using properties
Modifying the item displayed in Table controls populated programmatically, based on a data file and based on a variable
Table control populated programmatically
List Box control populated programmatically
ListView control
Limitations

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

DisplayedItem (Property)

In french: RubriqueAffichée

The DisplayedItem property is used to:

Find out the item or the variable displayed by the control.
Modify the item or the variable displayed by the control.

Remarks:

In the report "Opening" event, this property is used to modify the item displayed in a control when the data source of the report is modified through programming (by SourceName for example).
If this property is used in the control "Before printing" event, the change will be performed the next time the control is printed (indeed, the item value is already read when running the control "Before printing" event).
The displayed item can come from a data file, a view or a query.
The stored item or variable is defined in the window or page editor, in the "Content" tab of the control description.

For a ListView control, this item corresponds to the caption displayed in the ListView control.

Example

// -- Report opening
// Change the browsed data file
RPT_Report1.SourceName = Customer
// New item displayed in "CustomerName" control
CustomerName.DisplayedItem = "CustomerName"

// Change the data file associated with the report
// Switch from Customer data file to Prospect data file
RPT_CustomerReport.SourceName = Prospect
// Change the view associated with the report.
// This view is based on the Prospect data file
RPT_CustomerReport.ViewName = MyCustomerView84
CustomerName.DisplayedItem = "ProspectName"

// Modify the items displayed in "TABLE_CustomerTable"
TABLE_CustomerTable.DisplayedItem = "CustomerFirstName|CustomerLastName|ZIP|City"

// Modify the item displayed in "LIST_CustomerList"
LIST_CustomerList.DisplayedItem "CustomerFirstName"

Syntax

Finding out the item/variable displayed by a Table, List Box or Combo Box control Hide the details

<Item/variable currently displayed> = <Control used>.DisplayedItem

<Item/variable currently displayed>: Character string

Name of item displayed by the specified control. This item belongs to the data file browsed by the control (returned or modified by the BrowsedFile property).
Name of variable displayed by the specified control. This name has the following format:

":<prefix><Variable name>"

or

":<Variable name>"

(the prefix is applied only if the code style is enabled in the project).
This variable belongs to the variable browsed by the control (returned or modified with the BrowsedFile property).
For a Table control, list of the names of items or variables displayed by each column. The names of items/variables are separated by the "|" character (AltGr + 6 keys).

<Control used>: Control name

Name of the control to be used: Table, List Box, ListView or Combo Box.

Modifying the item/variable displayed by a Table, List Box or Combo Box control Hide the details

<Control used>.DisplayedItem = <New item/variable>

<Control used>: Control name

Name of the control to be used: Table, List Box, ListView or Combo Box.

<New item/variable>: Character string

Name of item that will be displayed in the specified control. This item belongs to the data file browsed by the control (returned or modified by the BrowsedFile property).
Name of variable that will be displayed in the specified control. This name has the following format:

":<prefix><Variable name>"

or

":<Variable name>"

The prefix must be specified only if the code style is enabled in the project (whether prefixes are displayed or not).
This variable belongs to the variable browsed by the control (returned or modified with the BrowsedFile property).
For a Table control, list of the names of items or variables displayed by each column. The names of items/variables are separated by the "|" character (AltGr + 6 keys).

Finding out the item displayed by a report control Hide the details

<Item currently displayed> = <Control used>.DisplayedItem

<Item currently displayed>: Character string

Name of item associated with the specified control. For a multi-file link, the item name has the following format:

<Name File1>.<Item name> + TAB + <Name File2>.<Item name>

This item corresponds to:
an item that belongs to the file used as data source for the report (returned or modified by SourceName).
an item (or its alias) belonging to the query used as data source of report.

<Control used>: Control name

Name of report control to use.
In a report, this control can be:
an Image control,
a Bar Code control,
an RTF Static control,
a Static control,
a Check Box control,
a Calculated control.
a Spreadsheet control

Modifying the item displayed by a report control Hide the details

<Control used>.DisplayedItem = <New item>

<Control used>: Control name

Name of report control to use.
In a report, this control can be:
an Image control,
a Bar Code control,
an RTF Static control,
a Static control,
a Check Box control,
a Calculated control.
a Spreadsheet control

<New item>: Character string

Name of new item associated with the specified control. For a multi-file link, the item name has the following format:

<Name File1>.<Item name> + TAB + <Name File2>.<Item name>

This item corresponds to:
an item that belongs to the file used as data source for the report (returned or modified by SourceName).
an item (or its alias) belonging to the query used as data source of report.

Remarks

Handling Table, Looper, List Box, ListView and Combo Box controls based on a data file using properties

The records displayed in a List Box, Table, Looper or Combo Box control based on a data file come from the data file or query specified with the BrowsedFile property.
The sort direction is defined by the BrowsedItem property.
The records can be filtered using the Filter property or the HFilter function.

Modifying the item displayed in Table controls populated programmatically, based on a data file and based on a variable

If <New item/variable> contains:

A number of items greater than the number of columns in the Table control, only the first items (or variables) are associated with the columns in the Table control.
A number of items lower than the number of columns in the Table control, the "additional" columns will not be associated with any item (or variable).

Remark: To associate a column with an item or with a variable, use DataBinding.

Table control populated programmatically

If a Table control populated programmatically must display data coming from a data file, a query or a view:

Create a Table control populated programmatically in the window editor.
In your program, specify the item that will be browsed by BrowsedItem. This item must be in the data file, query or view whose data will be displayed in the Table control populated programmatically.
Use FileToMemoryTable to initialize the Table control with the desired data. The data will be sorted according to the specified search item.
The DisplayedItem property will be automatically initialized.

List Box control populated programmatically

If a List Box or Combo Box control populated programmatically must display data from a data file, query or view:

Create a List Box or Combo Box control in the window editor.
Use FileToMemoryList to populate the List Box or Combo Box control with the desired data.
The BrowsedFile, DisplayedItem, BrowsedItem and StoredItem properties will be automatically initialized.

ListView control

For ListView controls, the DisplayedItem property is used to get and change only the item that corresponds to the captions of the elements displayed in the control.

To get and change the item that corresponds to the images displayed in the control, use the DisplayedItemImage property.

Limitations

In a window, the DisplayedItem property applies only to the following controls:

Table control,
List Box or ListView control,
Combo Box control.

In a page, the DisplayedItem property applies only to the following controls:

Table control,
Looper control,
List Box control,
Combo Box control.

In a report, the DisplayedItem property applies only to the following controls:

Image control.
Bar Code control.
RTF Static control.
Static control.
Check Box control.
calculated control.
Spreadsheet control.