ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Controls, pages and windows / Table functions
  • Use conditions
  • Characteristics of row elements
  • Position of inserted 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: Inserting several rows
  • Editable Table or TreeView Table control
  • Inserting images
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Inserts a row into a Table control or into a TreeView Table control with an animation. The duration of this animation can be configured:
  • in the "Style" tab of the Table control description window:
    • In the "Style" tab, select the "Control animation" element.
    • In the list of animations, select "Modification by TableXXXWithAnimation()" and click the "Parameters" button.
  • in the description window of the project:
    • In the "Advanced" tab, click "Control animations".
    • In the "Table and Looper control" area, select "Modification by TableXXXWithAnimation()" and click the "Parameters" button.
Remarks:
Example
// Insert the "Vince" and "Moore" elements into the fifth
// row of  the Table control "TABLE_CustomerTable"
TableInsertLineWithAnimation(TABLE_CustomerTable, 5, "Vince", "Moore")
Syntax
TableInsertLineWithAnimation(<Table control> [, <Index> [, <Element column 1> [... [, <Element column N>]]]])
<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 used will be the control to which the current event belongs.
<Index>: Optional integer
Index of the row into which the elements will be inserted. The index of the first row is set to 1.
Index not specifiedThe row is inserted before the current row. If no row is selected, the row is inserted at the bottom of the control.
Index greater than the number of control rowsThe row is inserted at the bottom of the control.
Index equal to 0The row is inserted at the beginning of the control.
Index equal to -1The 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 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)
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 control based on a data file, the default values defined in the linked data file are taken into account.
Remarks

Use conditions

TableInsertLineWithAnimation 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.
The animation is not played in the following cases:
  • if the animations are disabled (AnimationEnabled).
  • if the function is used in the following window processes: "Global declarations", "End of initialization" or "Closing".
  • if the application is in TSE mode.
  • if the insertion is performed outside the visible area (below or above). In this case, the insertion is performed and the function gives control back immediately.
The function gives control back at the end of animation only.

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:
    TableInsertLineWithAnimation(TABLE_CustomerTable, 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 with TableSort, the new row is positioned according to the current sort and not the specified index.
  • If the control is sorted by the user, the sort is ignored when inserting the row. The row is inserted at the specified position.

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 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 linked data file, TableSave must be called after TableInsertLineWithAnimation.
Remark: The "Cascading input (Add)" option can be selected in the "Details" tab of the control description.

Table or TreeView Table control based on a data file: Inserting several rows

A virtual row is created each time TableInsertLineWithAnimation is called in a Table or TreeView Table control based on a data file. The information will be saved in the data file during the call to TableSave.
If TableInsertLineWithAnimation 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 TableInsertLineWithAnimation 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), SetFocusAndReturnToUserInput must be used to resume the input in the Table or TreeView Table control.

Inserting images

To insert an image into a Table or TreeView Table control, specify the name and full path of the image to insert.
For example:
TableInsertLineWithAnimation(TABLE_MyTable, 5, "C:\MyDocuments\MyImage.BMP")
Remark: The column must be an Image column otherwise the inserted image will not be displayed properly.
Business / UI classification: UI Code
Component: wd300obj.dll
Minimum version required
  • Version 22
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 05/26/2022

Send a report | Local help