TableEnumColumn (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Controls, pages and windows / Table functions

Use conditions
The different types of column indices

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

TableEnumColumn (Function)

In french: TableEnumèreColonne

Returns the name of a column found in a Table or Treeview Table control.

Example

// Name of third column found in the "TABLE_ProductTable" control
ResColumnName = TableEnumColumn(TABLE_ProductTable, 3)

// Handle the column via a Control variable
pCol is Control
pCol <- TableEnumColumn(TABLE_ProductTable, 3)

// Enumerate all columns found in the Table control "TABLE_ProductTable"
AColumn is Control
FOR nColumn = 1 _TO_ TableCount(TABLE_ProductTable, toColumn)
AColumn <- TableEnumColumn(TABLE_ProductTable, nColumn)
Trace(AColumn.FullName + "//" + AColumn.Title)
END

Syntax

<Result> = TableEnumColumn(<Table control> , <Column index>)

<Result>: Character string

Column name.
This result can be assigned to a Control variable.
Empty string ("") if <Column index> is equal to the number of columns in the Table control + 1.

<Table control>: Control name

Name of the Table control to be used.
If this parameter corresponds to an empty string (""), the Table control to which the current process belongs will be used.

<Column index>: Integer

Index of the column, between 1 and the number of columns in the Table control + 1.
A WLanguage error occurs if this parameter is greater than the number of columns found in the Table control + 1.
To find out the number of columns in a Table control, use TableCount.

Remarks

Use conditions

TableEnumColumn can be used on:

a Table control based on a data file or populated programmatically.
a TreeView Table control based on a data file or populated programmatically.
a single-selection or multiselection control,

Reminder: Multi-selection is not available for "classic" Table controls.

The different types of column indices

There are 2 types of indices for columns:

Index of the visible position: index of the column when the window is executed.
Creation index: index of the column when the control is created in the window editor.

These two types of indices are returned by TableColumnIndex.

These indices change if the user moves the columns.

TableEnumColumn uses the column creation index.

Component: wd300obj.dll