TableInsertLine (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

Characteristics of row elements
Position of inserted row
Limits: Maximum number of lines displayed
Table field/Hierarchical file table: Changes to the linked data file
Table field/Hierarchical table file: Insert several lines
Editable Table or TreeView Table control
Inserting an image

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

TableInsertLine (Function)

In french: TableInsèreLigne

Inserts a row into:

a Table control,
a TreeView Table control.

Remarks:

To add elements at the end of a Table control, use TableAddLine.
To add rows inside a hierarchy (TreeView Table control), use TableInsertChild.
To insert a row with an animation, use TableInsertLineWithAnimation.

Example

// Insertion des éléments "Paul" et "Dubois" dans la cinquième
// ligne de la table "TABLE_TableClient"
TableInsertLine(TABLE_TableClient, 5, "Paul", "Dubois")

// Insertion d'une ligne en dessous de la ligne sélectionnée
TableInsertLine(TABLE_Contact, TABLE_Contact + 1, "Nouveau contact")
TableSelectPlus(TABLE_Contact, TABLE_Contact + 1)

Syntax

TableInsertLine(<Table control> [, <Subscript> [, <Element column 1> [... [, <Element column N>]]]])

<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.

<Subscript>: Optional integer

Index of the row into which the elements will be inserted. The index of the first row is set to 1.
Index not specified The row will be inserted before the current row. If no row is selected, the row is inserted at the bottom of the control.
Index greater than the number of control rows The row is inserted at the bottom of the control.
Index equal to 0 The row is inserted at the beginning of the control.
Index equal to -1 The row will be inserted before the current row.

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

First row elements that will be inserted into the specified control. Each element corresponds to a control column. The type of inserted 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)

Nth row elements that will be inserted into the specified control. Each element corresponds to a control column. The type of inserted 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

TableInsertLine 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.
Reminder: Multi-selection is not available for Table fields in "Server" mode.

This function is available for Table controls in "Server" and "Server + AJAX" mode, and for TreeView Table controls.

This function is available for Table controls in "Browser" mode only.

The TreeView Table control is not available.

Table controls based on a data file are not available in edit mode. TableInsertLine cannot be used on Table controls based on a data file.

Characteristics of row elements

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

Position of inserted row

By default, the row is inserted at the specified position.

Special cases:

If the control is sorted with TableSort, the new row is positioned according to the current sort and not the specified index.
If the control is sorted by the user, the sort is ignored when inserting the row. The row is inserted at the specified position.

Limits: Maximum number of lines displayed

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

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 content of 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 content of data file linked to the control is not modified. To write the content of inserted row into the data file, TableSave must be called after TableInsertLine.

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.
Cascading input is only available for "Server + AJAX" Table controls based on a data file.

Table field/Hierarchical table file: Insert several lines

A virtual row is created each time TableInsertLine is called in a Table or TreeView Table control based on a data file. The information will be saved in the data file during the call to TableSave.

If TableInsertLine 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.

This operating mode is only available for "Server + AJAX" Table controls based on a data file.

Editable Table or TreeView Table control

If TableInsertLine is called:

In a control event, the cursor is automatically positioned on the first column to edit in the inserted 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.

Inserting an image

To insert an image into a Table or TreeView Table control:

specify the name and full path of image to insert.
For example:

TableInsertLine(TABLE_MaTable, 5, "C:\MesDocuments\MonImage.BMP")

specify the path and name of image to insert. The path is relative to the "<Project_Name>_WEB" directory.
For example:
// Ajoute l'image située dans le répertoire "WB_MonAppli_WEB" TableInsertLine(TABLE_MaTable, "MonImage.BMP")

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

Component: wd300obj.dll