<Table>.InsertLine (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

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

Characteristics of row elements
Position of inserted row
Limitations: Maximum number of rows displayed
Table or TreeView Table control based on a data file: Modifications in the linked data file
Table or TreeView Table control based on a data file: Inserting several rows
Editable Table or TreeView Table control
Inserting an image

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Table>.InsertLine (Function)

In french: <Table>.InsèreLigne

Inserts a row into:

a Table control,
a TreeView Table control.

Remarks:

To add elements at the end of a Table control, use <Table>.AddLine.
To add rows inside a hierarchy (TreeView Table control), use <TreeView Table>.InsertChild.
To insert a row with an animation, use <Table>.InsertLineWithAnimation.

Example

// Insert the "Vince" and "Moore" elements into the fifth
// row of the "TABLE_CustomerTable" control
TABLE_CustomerTable.InsertLine(5, "Vince", "Moore")

// Insert a row below the selected row
TABLE_Contact.InsertLine(TABLE_Contact + 1, "New contact")
TABLE_Contact.SelectPlus(TABLE_Contact + 1)

Syntax

<Table control>.InsertLine([<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.

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

<Table>.InsertLine can be used on:

a Table or TreeView Table control based on a data file.
a Table or TreeView Table control populated programmatically.
a single-selection or multi-selection control.
Reminder: Multi-selection is not available for Table controls 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. <Table>.InsertLine 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:
TABLE_CalcTable.InsertLine(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 <Table>.Sort, 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.

Limitations: Maximum number of rows displayed

The maximum number of rows that can be displayed in a Table or TreeView Table control is limited by the amount of available memory (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 or TreeView Table control based on a data file: Modifications in 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, <Table>.Save must be called after <Table>.InsertLine.

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 or TreeView Table control based on a data file: Inserting several rows

A virtual row is created each time <Table>.InsertLine 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 <Table>.Save.

If <Table>.InsertLine is successively called in the same process without being followed by <Table>.Save, 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 <Table>.InsertLine 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:
TABLE_MyTable.InsertLine(5, "C:\MyDocuments\MyImage.BMP")
specify the path and name of image to insert. The path is relative to the "<Project_Name>_WEB" directory.
For example:
// Adds the image found in the "WB_MyApp_WEB" directory
TABLE_MyTable.InsertLine("MyImage.BMP")

Remark: The column must be an Image column otherwise the inserted image will not be displayed properly.

Component: wd300obj.dll