TableInsert (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Characteristics of inserted row

Position of inserted row

Limits: Maximum number of rows displayed

Various

Adding rows

Cascading input

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 images

See also

TableInsert (Function)

In french: TableInsère

Inserts a row into:

a Table control,
a TreeView Table control,
a table displayed in a Combo Box control.

Versions 16 and later

This function is now available for WINDEV applications in Linux.

New in version 16

This function is now available for WINDEV applications in Linux.

Remarks:

It is recommended to use TableInsertLine. TableInsertLine is used to insert:
- TAB characters into the columns,
- all types of values into the columns.
To add rows inside a hierarchy (TreeView Table control), use TableInsertChild.

Example

// Insert the "Vince" and "Moore" elements
// into the 5th row of "TABLE_CustomerTable" control
ResInsert = TableInsert(TABLE_CustomerTable, "Vince" + TAB + "Moore", 5)

Syntax

<Result> = TableInsert(<Table control> [, <Row> [, <Subscript>]])

<Result>: Boolean

True if the element was inserted,
False otherwise.

<Table control>: Control name

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

<Row>: Optional character string

Row to insert. This row has the following format:

<Element column1> + TAB + <Element column2> + TAB + ...

If this parameter is not specified, an empty row is inserted into the control. For a browsing control, the default values defined in the linked data file are taken into account.

<Subscript>: Optional integer

Subscript of the row to insert. 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.

Remarks

TableInsert can be used on:

a browsing or memory control,
a single-selection or multiselection control.

Characteristics of inserted row

Each inserted element is converted into the type of relevant column.
To specify no value for an element, use an empty string ("") or 0 (according to the type of column). For example:

TableInsert(TABLE_CustomerTable, "Moore" + TAB + "Vince" + TAB + "" + TAB + "06/21/72")
If an element corresponds to the calculation result, the numeric expression must be enclosed in brackets. For example:

TableInsert(TABLE_CalcTable, (53+29) + TAB + (83-21))

Position of inserted row

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

Special cases:

If the control is sorted by TableSort, 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).

Various

To add rows at the end of a Table or TreeView Table control, use TableAddLine.

Adding rows

..NewLine is used to find out whether the current row was just created by TableInsert (..NewLine = True).

Cascading input

To perform cascading input, TableInsert must be used in the exit process of a row of Table control:

IF TABLE_CustomerTable..NewLine = True THEN
TableInsert(TABLE_CustomerTable)
END

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, TableSave must be called after TableInsert.

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 TableInsert is called in a browsing Table or TreeView Table control. The information will be saved in the data file during the call to TableSave.

If TableInsert is successively called in the same process without being followed by TableSave, only the FIRST call is effective (the following calls are ignored). A single row is added into the browsing Table or TreeView Table control.

Editable Table or TreeView Table control

If TableInsert 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 images

To insert an image into a Table control:

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

TableInsert(TABLE_MyTable, "C:\MyDocuments\MyImage.BMP")

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

Component : wd250obj.dll