<Table>.Add (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
Row characteristics
Position of the new row
Limits: Maximum number of lines displayed
Miscellaneous
Adding rows
Cascading input
Table field/Hierarchical file table: Changes to the linked data file
Table field/Hierarchical table file: Add several lines
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

<Table>.Add (Function)

In french: <Table>.Ajoute

Adds a row in:

a Table control,
a TreeView Table control,
a Combo Box control "with table" (Table control displayed in a Combo Box control).

Note: We recommend using the <Table>.AddLine function.. <Table>.AddLine is used to add:

TAB characters into the columns,
all types of values into the columns,
UNICODE data automatically and without conversion.

Example

// Ajout de "Dubois", "Pierre" et "21/06/72"
// à la fin du champ "TABLE_TableClient"
ResAjout = TABLE_TableClient.Ajoute("Dubois" + TAB + "Pierre" + TAB + "21/06/72")

Syntax

<Result> = <Table control>.Add([<Row>])

<Result>: Boolean

True if the element was added,
False otherwise.

<Table control>: Control name

Name of the control to be used. This control can correspond to:
a Table control.
a TreeView Table control.
a Combo Box control with table.

<Row>: Optional character string

Row to add. This row has the following format:
<Elément de la colonne 1> + TAB + <Elément de la colonne 2> + TAB + ...

If this parameter is not 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

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

Row characteristics

Each added element is converted into the type of the relevant column.

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

TABLE_TableClient.Ajoute("Dubois" + TAB + "Pierre" + TAB + "" + TAB + "21/06/72")

If an element corresponds to the calculation result, the numeric expression must be enclosed in brackets. For example:
```
TABLE_TableCalcul.Ajoute((53+29) + TAB + (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 <Table>.Sort, 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.

Limits: Maximum number of lines displayed

The maximum number of rows that can be displayed in a TreeView Table control or Hierarchical Table is limited only by available RAM (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).

Miscellaneous

To add a row at a specific position in a Table or TreeView Table control, use <Table>.InsertLine.
If the added row is the first row of the control, the added row becomes the current row.

Adding rows

The NewLine property is used to determine if the current row has just been created by <Table>.Add (NewLine = True).

Cascading input

To perform a cascading input, <Table>.Add must be used in the "Exit a row" event of the Table control:

IF TABLE_TableClient.Nouveau THEN
	TABLE_TableClient.Ajoute()
END

This function is only available for Table fields in Ajax mode..

Table field/Hierarchical file table: Changes to 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, <Table>.Save must be used after <Table>.Add.

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: Add several lines

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

If <Table>.Add 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.

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

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 <Table>.Add 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 to a Table or TreeView Table control:

specify the name and full path of the image to be added.
For example:
TABLE_MaTable.Ajoute("C:\MesDocuments\MonImage.BMP")
specify the path and name of image to add. The path is relative to the "<Project_Name>_WEB" directory.
For example:
// Ajoute l'image située dans le répertoire "WB_MonAppli_WEB" TABLE_MaTable.Ajoute("MonImage.BMP")

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

Component: wd300obj.dll