TableAddLine (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

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

Use conditions
Characteristics of row elements
Position of the new 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: Adding several rows
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

// Add "Moore" and "Vince"
// in the last row of the "TABLE_ProductTable" control
TableAddLine(TABLE_ProductTable, "Moore", "Vince")

// Example of Table control
// with a "List of values" column (WEBDEV) or a "Combo box" column (WINDEV).
// This column can be filled in its description
// or through programming.
// The example below processes the case through programming.

// 1 - Adding possible values into the "List of values" or "Combo box" column
ListAdd(TABLE_MyTable.COL_Value, "Val 1")
ListAdd(TABLE_MyTable.COL_Value, "Val 2")
ListAdd(TABLE_MyTable.COL_Value, "Val 3")
ListAdd(TABLE_MyTable.COL_Value, "Val 4")

// 2 - Adding rows with elements selected 
// into the "List of values" or "Combo box" column
// the second column corresponds to the list values/combo box.
// Only the index to select in the list of values or combo box is specified.
TableAddLine(TABLE_MyTable, "row1", 1) // Where 1 corresponds to "Val 1"
TableAddLine(TABLE_MyTable, "row2", 4) // Where 4 corresponds to "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:

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. TableAddLine cannot be used on Table controls based on a data file.

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_CalcTable, (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.

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 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.
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: Adding several rows

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.

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

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.

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

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 into a Table or TreeView Table control:

specify the name and full path of the image to be added. For example:
TableAddLine(TABLE_MyTable, "C:\MyDocuments\MyImage.BMP")
specify the path and name of image to add. The path is relative to the "<Project_Name>_WEB" directory. For example:
// Adds the image found in the "WB_MyApp_WEB" directory TableAddLine(TABLE_MyTable, "MyImage.BMP")

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

Component: wd300obj.dll