<Table>.Add (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Characteristics of a row

Position of added 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: Adding several rows

Adding a record into a browsing Table control and releasing a trigger

Browsing Table or TreeView Table control in edit

Adding images

See also

<Table>.Add (Function)

In french: <Table>.Ajoute

Adds a row into:

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

Remark: It is recommended to use <Table>.AddLine. <Table>.AddLine is used to add:

TAB characters into the columns,
all types of values into the columns.

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.

Versions 19 and later

This function is now available in Browser code for Table controls in browser mode.

New in version 19

This function is now available in Browser code for Table controls in browser mode.

Versions 20 and later

This function is now available for Android applications.

This function is now available for iPhone/iPad applications.

New in version 20

This function is now available for Android applications.

This function is now available for iPhone/iPad applications.

This function is now available for Android applications.

This function is now available for iPhone/iPad applications.

Example

// Add "Moore", "Vince" and "06/21/72"
// at the end of the "TABLE_CustomerTable" control
ResAdd = TABLE_CustomerTable.Add("Moore" + TAB + "Vince" + TAB + "06/21/72")

Syntax

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

<Result>: Boolean

True if the element was added,
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.

<Row>: Optional character string

Row to add. This row has the following format:

<Element of column 1> + TAB + <Element of column 2> + TAB + ...

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

Use conditions

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

This function is available for Table controls in browser mode only.

The TreeView Table control is not available.

The browsing Table controls are not available in edit. <Table>.Add cannot be used on a browsing Table control.

Characteristics of a row

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_CustomerTable.Add("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:

TABLE_CalculationTable.Add((53+29) + TAB + (83-21))

Position of added 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 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 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 Property New indicates whether the current row has just been created by the <Table>.Add function (Property New = True).

Cascading input

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

IF TABLE_TableClient.New THEN

 TABLE_CustomerTable.Add()

END

This operating mode is available for Table controls in Ajax mode only.

Browsing Table or TreeView Table control: 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 added row into the linked data file, <Table>.Save must be used after <Table>.Add.

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.
Versions 19 and later
The cascading input is available for the Ajax browsing Table controls only.
New in version 19
The cascading input is available for the Ajax browsing Table controls only.
The cascading input is available for the Ajax browsing Table controls only.

Browsing Table or TreeView Table control: Adding several rows

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

Adding a record into a browsing Table control and releasing a trigger

You have the ability to release a trigger when a record is added into a browsing Table control. For more details, see the <Source>.DescribeTrigger documentation..

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

Browsing Table or TreeView Table control in edit

If <Table>.Add is called:

In a control event, the cursor is automatically positioned on the first column to edit in the added 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.

Adding images

To add an image into a Table or TreeView Table control:

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

TABLE_MyTable.Add("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
TABLE_MyTable.Add("MyImage.BMP")

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

Component: wd260obj.dll