TableAddLine (Function)

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 functions / Controls, pages and windows / Table functions

Use conditions
Characteristics of row elements
Position of the new row
Limits: Maximum number of lines displayed
Table field/Hierarchical file table: Changes to the linked data file
Table field/Hierarchical table file: Add several lines
Adding a record to a Table control based on a data file and releasing a trigger
Table or TreeView Table control based on a data file in edit mode
Adding images

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

TableAddLine (Function)

In french: TableAjouteLigne

Adds a row in:

a Table control,
a TreeView Table control.

If the added row is the first row of the control, the added row becomes the current row.

Remarks:

To add a row at a specific position, use TableInsertLine.
To add a row with an animation, use TableAddLineWithAnimation.

Example

// Ajout des éléments "Dubois" et "Pierre"
// dans la dernière ligne du champ "TABLE_TableProduit"
TableAddLine(TABLE_TableProduit, "Dubois", "Pierre")

// Exemple de champ Table
// avec une colonne "Liste de valeurs" (WEBDEV) ou "Combo" (WINDEV).
// Cette colonne peut être remplie directement dans sa description
// ou par programmation.
// L'exemple ci-dessous traite le cas par programmation.

// 1 - Ajout des valeurs possibles dans la colonne "liste de valeurs" / Combo
ListAdd(TABLE_MaTable.COL_Valeur, "Val 1")
ListAdd(TABLE_MaTable.COL_Valeur, "Val 2")
ListAdd(TABLE_MaTable.COL_Valeur, "Val 3")
ListAdd(TABLE_MaTable.COL_Valeur, "Val 4")

// 2 - Ajout de lignes avec des éléments sélectionnés 
// dans la colonne "liste de valeurs" ou Combo
// ici la seconde colonne correspond à la liste de valeurs / combo.
// Seul l'indice à sélectionner dans la liste de valeurs ou combo est précisé.
TableAddLine(TABLE_MaTable, "ligne 1", 1) // Où 1 correspond à "Val 1"
TableAddLine(TABLE_MaTable, "ligne 2", 4) // Où 4 correspond à "Val 4"

Syntax

<Result> = TableAddLine(<Table control> [, <Element column 1> [... [, <Element column N>]]])

<Result>: Integer

Index of the added row,
-1 if an error occurred.

<Table control>: Control name

Name of the control to be used. This control can correspond to:
a Table control.
a TreeView Table control.
If this parameter corresponds to an empty string (""), the control to which the current event belongs will be used.

<Element column 1>: Type of associated column (optional)

Elements of the row that will be added into the specified control. Each element corresponds to a control column. The type of the added element must be compatible with the type of relevant column.
If none of these parameters is specified, an empty row is added into the control. For a control based on a data file, the default values defined in the linked data file are taken into account.

<Element column N>: Type of associated column (optional)

Elements of the row that will be added into the specified control. Each element corresponds to a control column. The type of the added element must be compatible with the type of relevant column.
If none of these parameters is specified, an empty row is added into the control. For a control based on a data file, the default values defined in the linked data file are taken into account.

Remarks

Use conditions

TableAddLine can be used on:

Table or TreeView Table controls based on a data file.
Table or TreeView Table controls populated programmatically.
single-selection or multi-selection controls.

Characteristics of row elements

To specify no value for an element, use an empty string ("") or 0 (according to the type of column).
If an element corresponds to the calculation result, the numeric expression must be enclosed in brackets.
For example:
```
TableAddLine(TABLE_TableCalcul, (53+29), (83-21))
```

Position of the new row

By default, the row is added at the end of the rows displayed by the control.

Special case:

If the control is sorted by TableSort, the added row is positioned in the control according to the current sort.
If the control is sorted by the user, the sort is ignored when inserting the row. The row is added at the end of control.

Limits: Maximum number of lines displayed

The maximum number of rows that can be displayed in a TreeView Table control or Hierarchical Table is limited only by available RAM (theoretical maximum: 2 billion rows).

However, we do not advise you to use large Table or TreeView Table controls for performance and user-friendliness reasons (time required to fill the control for example).

Table field/Hierarchical file table: Changes to the linked data file

If the cascading input is enabled, the data file linked to the control is automatically modified when the user goes to the next row.
If the cascading input is not enabled, the data file linked to the control is not modified. To write the content of the new row to the linked data file, TableSave must be used after TableAddLine.

Remarks:

The "Cascading input (Add)" option can be selected in the "Details" tab of the control description.
The cascading input is not available for Table controls with direct access to the data source. This option is only available for Table controls populated programmatically and with in-memory data source.

Table field/Hierarchical table file: Add several lines

A virtual row is created each time TableAddLine is called in a Table or TreeView Table control based on a data file. The information will be saved in the linked data file only when TableSave is called.

If TableAddLine is successively called in the same process without being followed by TableSave, only the FIRST call is effective (the following calls are ignored). Only one row is added to the Table or TreeView Table control.

Adding a record to a Table control based on a data file and releasing a trigger

A trigger can be released when a record is added in a Table control based on a data file. For more details, see the documentation about HDescribeTrigger.

Table or TreeView Table control based on a data file in edit mode

If TableAddLine is called:

In a control event, the cursor is automatically positioned on the first editable column in the new row.
In an event that does not belong to the control (or in another process), SetFocusAndReturnToUserInput must be used to resume the input in the Table or TreeView Table control.

Adding images

To add an image to a Table or TreeView Table control:

specify the name and full path of the image to be added. For example:
TableAddLine(TABLE_MaTable, "C:\MesDocuments\MonImage.BMP")

Note: To display the added image correctly, the column must be of type Image.

Component: wd300obj.dll