BuildBrowsingTable (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Table functions

Prefix syntax

BuildBrowsingTable

Presentation

Example

Characteristics of the Table control (by default)

Table control populated programmatically

Columns

Miscellaneous

See also

BuildBrowsingTable (Function)

In french: ConstruitTableFichier

Creates a Table control from the items of a data file (view or query). Each column of the control is bound to an item in the data file. The width of the columns changes automatically according to the data in the file or query.

This function is used to get a Table control adapted to the browse of a specific data file.

Example

See additional examples

// Displays the content of "CUSTOMERS" file in a Table control based on a data file
BuildBrowsingTable(TABLE_TABLE1, "CUSTOMERS", taWithAutoID)

// Displays the query content in a Table control populated programmatically
IF HExecuteQuery(QRY_LIST_ACTIVE_CUSTOMERS) = True THEN
BuildBrowsingTable(TABLE_CUSTOMERS, ...
QRY_LIST_ACTIVE_CUSTOMERS, taFillTable)
END

Syntax

BuildBrowsingTable(<Table control> , <Data file> [, <Options>])

<Table control>: Control name

Name of the Table control (based on a data file or populated programmatically).
Caution: This control must exist in the window. It may have been created by ControlCreate.
The records in the data file can be viewed directly if this parameter corresponds to a Table control based on a data file.

<Data file>: Character string

Name of data file, view or query used as a base for creating the Table control.

<Options>: Optional constant (or combination of constants)

Configures the creation mode of columns in the Table control.
Operating mode with the constant Default operating mode
taWithBinary Binary items (link composite key for example) are added to the Table control. By default: Binary items (link composite key for example) are not added to the Table control.
taWithAutoID A column is generated for the automatic identifier. By default: No column for the automatic identifier.
taWithDetailsBinding A sub-table is automatically generated to display the bound items from the data files of the analysis. By default: No "row details" window is displayed.
taKeepBrowseKey The search key of the Table control based on a data file does not change (this search key is returned by the BrowsedItem property). By default: The first key item found is positioned as search key.
taKeepColumn The existing columns in the Table control are not deleted. By default: The existing columns are deleted.
taItemCaption The captions of items are used for the titles of columns. By default: The name of the item is used as column title.
taByLogicalOrder The columns are created according to the logical order of items defined in the data model editor.
For the queries, the logical order and the physical order of items are identical. By default: The physical order of the items in the data file is used.
For the queries, the logical order and the physical order of items are identical.
taFillTable Table controls are populated programmatically with the content from the data file (Caution: this can be a long operation that may cause the memory to overflow). By default: Table controls are not populated programmatically.
taWithAutoID Input allowed in the column associated with the automatic identifier (if it exists and if the Table control is in edit).
taNoAdjust The width of the columns is not adjusted (the records are not read).
taNoMemoText The 'text memo' items are not added into the Table control. By default: The "text memo" items are added into the Table control.
taNoMemoImage The "image memo" items are not added into the Table control. By default: The "image memo" items are added into the Table control.

Remarks

Characteristics of the Table control (by default)

The columns of Table control defined in the editor are deleted.
The input modes defined in the editor for the Table control are kept.
A column whose type is identical to the item type is created for each item of the data file.
No column is created for the binary memo items (a column is created for the text memo items or for the image memo items).
The properties of Table controls and columns are updated to allow the file to be browsed through:

<Table control>.BrowsedFile = <Data file name>

and for each column:

<Column name>.DataBinding = <Name of the bound item>
<Column name>.BrowsedItem = <First key in data file>

Table control populated programmatically

If <Table control> corresponds to a Table control populated programmatically, no data is displayed (the Table control is empty) but the Table control and column properties are assigned like in the case of a Table control based on a data file.

To display data in the Table control, use the TableAdd or BuildBrowsingTable functions with the taFillTable constant.

Remark: The taFillTable constant cannot be used to programmatically populate Table controls with image memos. To add an image into a Table control populated programmatically, the corresponding file must be found in the application library (WDL file) or it must be accessible from the current computer.

Columns

The created columns are named "_COL1", "_COL2", "_COL3", etc. These columns are accessible by programming via the indirection operator { }.

You cannot write:

TABLE_TABLE1._COL1.Width = 120 // Generates an error "_COL1 unknown"

You must write:

{"TABLE_TABLE1._COL1"}..Width = 120

Miscellaneous

BuildBrowsingTable browses through the data file. The current record may be modified once this function has been used.
The table is populated by BuildBrowsingTable in a parallel process in the background: if the data source is a query, this query must not be freed before closing the window or before reinitializing the Table control.

Component: wd280obj.dll