<Table>.InsertLine (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Characteristics of row elements

Position of inserted row

Limits: Maximum number of rows displayed

Browsing Table or TreeView Table control: Modifications in the linked data file

Browsing Table or TreeView Table control: Inserting several rows

Editable Table or TreeView Table control

Inserting an image

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.

Versions 18 and later

This function can now be used to handle TreeView Table controls in WEBDEV and PHP sites.

New in version 18

This function can now be used to handle TreeView Table controls in WEBDEV and PHP sites.

This function can now be used to handle TreeView Table controls in WEBDEV and PHP sites.

Example

// Insert the "Vince" and "Moore" elements into the fifth
// row of "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 control to use. This control can correspond to:
a Table control.
a TreeView Table control.

<Subscript>: Optional integer

Subscript of row into which the elements will be inserted. The subscript of first row is set to 1.
Subscript not specified The row is inserted before the current row. If no row is selected, the row is inserted at the end of control.
Subscript greater than the number of control rows The row is inserted at the end of control.
Subscript equal to 0 The row is inserted at the beginning of control.
Subscript 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 browsing control, 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 browsing control, the default values defined in the linked data file are taken into account.

Remarks

<Table>.InsertLine can be used on:

a browsing or memory control,
a single-selection or multiselection control.
Reminder: Multiselection is not available for Table controls in classic mode.

This function is available for Table controls in Ajax mode, Table controls in classic mode and TreeView Table controls.

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 by <Table>.Sort, the inserted row is positioned in the control according to the current sort (and not according to the specified subscript).
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 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).

Browsing Table or TreeView Table control: 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 (Addition)" option can be selected in the "Details" tab of the control description.
The cascading input is not available for the browsing Table controls with direct access. This option is available for the memory Table controls and for the browsing Table controls loaded in memory.

Browsing Table or TreeView Table control: Inserting several rows

A virtual row is created in the control whenever <Table>.InsertLine is called in a browsing Table or TreeView Table control. 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). A single row is added into the browsing Table or TreeView Table control.

This operating mode is available for the browsing Ajax Table controls only.

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) ReturnToCapture 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 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: wd260obj.dll