BrowsedFile (Property)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage properties / HFSQL properties

Using the BrowsedFile property
Changing the properties linked to the iteration of a data-bound control
Type of iteration
Manipulating the data-bound controls via the properties
Limits

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

BrowsedFile (Property)

In french: FichierParcouru

The property BrowseFile property lets you find out and modify the data source used to display records in fields based on a data file or variable:

Table or hierarchical Table fields.
List Box control or Image control.
Combo Box controls.
combo table columns.
RepeatString fields.
the Scheduler controls.
Kanban control fields.
internal windows (if the swipe gesture is enabled).
supercontrols.

This data source can be:

a data file or a query. The records displayed are from this data file or query.
a variable (array, class member, member of an advanced type, etc.).

This data source is defined in the control description ("Content" tab).

Example

// Affiche tous les clients dans un champ Table
TABLE_Table1.FichierParcouru = "Clients"
// Affiche tout le contenu de la requête Req_Clients dans un champ Table
TABLE_Table1.FichierParcouru = "Req_Clients"

// Affiche les contacts de la variable gUnContact
// gUnContact est une variable de type gglContact
TABLE_Table1.FichierParcouru = ":gUnContact"

Syntax

Getting the data file, query or variable used as data source Hide the details

<Browsed element> = <Control used>.BrowsedFile

<Browsed element>: Character string

Name of the element used as data source for the relevant control. This element can correspond to:
the name of the data file or query.
the name of the variable. 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.

<Control used>: Control name

Name of the control used. The type of this control must be:
Table, TreeView Table.
List, Image list.
Combo Box.
Combo table column.
Looper.
Scheduler.
Internal window.
Kanban.

Changing the data file, query or variable used as data source Hide the details

<Control used>.BrowsedFile = <New data source>

<Control used>: Control name

Name of the control used. The type of this control must be:
Table, TreeView Table.
List, Image list.
Combo Box.
Combo table column.
Looper.
Scheduler.
Internal window.
Kanban.

<New data source>: Character string

Name of the element that must be associated with the relevant control:
Name of the data file or name of the query.
Variable name. 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 or not prefixes are displayed).
The control will be empty if this parameter does not correspond to a valid name. The iteration will be stopped if this parameter is an empty string.

Remarks

Using the BrowsedFile property

The property BrowsedFile property can be used for both programmed and automation browsing of the data source.

If the BrowsedFile property is used to change the data source used, the iteration operation starts over again. For a Table control, this operating mode is identical to the use of TableDisplay associated with the taStart constant.

Changing the properties linked to the iteration of a data-bound control

To change multiple properties (BrowsedItem, Filter and BrowsedFile) it is recommended to:

Stop the iteration by assigning an empty string ("") to the BrowsedFile property.
Change the relevant properties.
Restart the iteration with the BrowsedFile property.

This method is used to optimize the modifications performed. Each one of the modifications made individually restarts the iteration. These operations can become quite slow when they are performed on large data files.

Type of iteration

Automatic file path WINDEV, WEBDEV and WINDEV Mobile support data file browsing and display of data in the field. No specific programming is required.
If the control can be sorted (table...), the sort is performed on the search item defined in the "Content" tab of the element description.
If a filter is specified ("Filter on the search item" in the "Content" tab of the object description), this filter is used.
Programmed path: The developer must program the path of the data file and the display of data in the.
A programmed iteration allows you to sort and filter records with precision. However, a programmed iteration is slower and more complex than an automatic iteration.

Manipulating the data-bound controls via the properties

The records displayed in the browsing controls come from the data file or query specified by the BrowsedFile property.
The sort direction is defined by the BrowsedItem property.
Depending on the type of control, the records can be filtered using the Filter property or the HFilter function.

Limits

The BrowsedFile property applies only to controls in a window or page. This property only applies to fields that can be linked to a data source:

Table and TreeView Table controls,
List Box control, Image control,
Combo Box controls,
Supercontrols,
Table columns (used to modify the data file linked to a Combo Box table column).
Looper controls,
Scheduler controls.
internal windows (if the swipe gesture is enabled).
Kanban control fields.