PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN

  • 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 records to a Table control based on a data file and Trigger
  • Editable Table or TreeView Table control
  • Adding 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
Adds a row to a Table or TreeView Table control with an animation. The duration of this animation can be configured:
  • in the "Style" tab of the Table (or TreeView 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 "Animations of controls".
    • In the "Table and Looper control" area, select "Modification by TableXXXWithAnimation()" and click the "Parameters" button.
If the added row is the first row of the control, the added row becomes the current row.
Remarks:
Example
// Add "Moore" and "Vince"
// in the last row of the "TABLE_ProductTable" control
TableAddLineWithAnimation(TABLE_ProductTable, "Moore", "Vince")
Syntax
<Result> = TableAddLineWithAnimation(<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

TableAddLineWithAnimation 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 events: "Global declarations", "End of initialization" or "Closing".
  • if the application is in TSE mode.
  • if the addition is performed outside the visible area (below or above). In this case, the addition 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 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:
    TableAddLineWithAnimation(TABLE_CalculationTable, (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 Table control based on a data file is not modified. To write the content of the new row to the linked data file, TableSave must be used after TableAddLineWithAnimation.
Remark: The "Cascading input (Addition)" option can be selected in the "Details" tab of the control description.

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

A virtual row is created each time TableAddLineWithAnimation is called in a Table or TreeView Table control based on a data file. The information will be saved in the linked data file during the call to TableSave.
If TableAddLineWithAnimation 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 control.

Adding records to a Table control based on a data file and 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.

Editable Table or TreeView Table control

If TableAddLineWithAnimation 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:
TableAddLineWithAnimation(TABLE_MyTable, "C:\MyDocuments\MyImage.BMP")
Remark: The column must be an Image column otherwise the added image will not be displayed properly.
Component: wd270obj.dll
Minimum version required
  • Version 22
This page is also available for…
Comments
Click [Add] to post a comment