The following constants are used to manage the Table, TreeView Table, Looper and List Box controls:
| | |
Constant | Description | Used by the functions |
---|
amDisplayDestination | Row movement: The modified row is displayed in the control. If necessary, the rows are automatically scrolled to display the modified row in the Table control. The selected row (selection bar) is not modified. This constant can be combined with the amMove and amSwap constants. | TableMoveLine ListMoveLine LooperMoveLine |
amFirst | Row movement: Moves the row to first position. | TableMoveLine ListMoveLine LooperMoveLine |
amLast | Row movement: Moves the row to last position. | TableMoveLine ListMoveLine LooperMoveLine |
amMove | Row movement: The row is moved toward the subscript of destination row. | TableMoveLine ListMoveLine LooperMoveLine |
amNext | Row movement: Moves the row one position downwards. | TableMoveLine ListMoveLine LooperMoveLine |
amNextPage | Row movement: Moves the row one page to the bottom (a page corresponds to the number of rows that can be simultaneously displayed in the Table, List Box or Looper control). | TableMoveLine ListMoveLine LooperMoveLine |
amPrevious | Row movement: Moves the row one position upwards | TableMoveLine ListMoveLine LooperMoveLine |
amPreviousPage | Row movement: Moves the row one page to the top (a page corresponds to the number of rows that can be simultaneously displayed in the Table, List Box or Looper control). | TableMoveLine ListMoveLine LooperMoveLine |
amSwap | Row movement: The source and destination rows are swapped. | TableMoveLine ListMoveLine LooperMoveLine |
filterContains | Displays the rows whose value for the specified column "Contains" the specified characters. | TableEnableFilter, TableInputSearch, MagnifierMode AssistedInputConfigure |
filterDifferent | Displays the rows whose value for the specified column "differs" from the specified characters. | TableEnableFilter, TableInputSearch, MagnifierMode AssistedInputConfigure |
filterDoesNotContain | Displays the rows whose value for the specified column "does not contain" the specified characters. | TableEnableFilter, TableInputSearch, MagnifierMode AssistedInputConfigure |
filterDoesNotEndWith | Displays the rows whose value for the specified column "does not end with" the specified characters. | TableEnableFilter, TableInputSearch, MagnifierMode AssistedInputConfigure |
filterDoesNotStartWith | Displays the rows whose value for the specified column "Does not start with" the specified characters. | TableEnableFilter, TableInputSearch, MagnifierMode property AssistedInputConfigure |
filterEndsWith | Displays the rows whose value for the specified column "ends with" the specified characters. | TableEnableFilter, TableInputSearch, MagnifierMode AssistedInputConfigure |
filterEqual | Displays the rows whose value for the specified column "is equal" to the specified characters. | TableEnableFilter, TableInputSearch, MagnifierMode AssistedInputConfigure |
filterGreater | Displays the rows whose value for the specified column "is greater than" the specified characters. | TableEnableFilter, TableInputSearch, Property MagnifierMode AssistedInputConfigure |
filterGreaterOrEqual | Displays the rows whose value for the specified column "is greater than or equal to" the specified characters. | TableEnableFilter, TableInputSearch, MagnifierMode AssistedInputConfigure |
filterLess | Displays the rows whose value for the specified column "is less" than the specified characters | TableEnableFilter, TableInputSearch, Property MagnifierMode AssistedInputConfigure |
filterLessOrEqual | Displays the rows whose value for the specified column "is less than or equal to" the specified characters. | TableEnableFilter, TableInputSearch, MagnifierMode property AssistedInputConfigure |
Versions 19 and laterfilterNone New in version 19filterNone filterNone | Disables the automatic filter used by the assisted input. The filter must be performed manually. | AssistedInputConfigure |
filterStartsWith | Displays the rows whose value for the specified column "Starts with" the specified characters. | TableEnableFilter, TableInputSearch, MagnifierMode property AssistedInputConfigure |
rowAverage | Used to handle the row corresponding to an automatic calculation (Mean type). | Automatic calculations in the tables |
rowCount | Used to handle the row corresponding to an automatic calculation (count type). | Automatic calculations in the tables |
Versions 22 and laterrowMaximum New in version 22rowMaximum rowMaximum | Used to handle the row corresponding to an automatic calculation (Maximum type). | Automatic calculations in the tables |
Versions 22 and laterrowMinimum New in version 22rowMinimum rowMinimum | Used to handle the row corresponding to an automatic calculation (Minimum type). | Automatic calculations in the tables |
rowSelected | Used to handle the row that is currently selected. | ListMoveLine TableMoveLine LooperMoveLine |
Versions 21 and latersearchContains New in version 21searchContains searchContains | Generic search whose type is "Contains" | TableSeek, LooperSeek, LooperSeekAnywhere |
searchDefault | - Sorts the Table control according to the specified column and switches the column to search mode.
Versions 21 and laterExact-match search whose type is "Equals to". New in version 21Exact-match search whose type is "Equals to". Exact-match search whose type is "Equals to".
| |
Versions 21 and latersearchExactMatch New in version 21searchExactMatch searchExactMatch | Exact-match search (whose type is "Equals to") | TableSeek, LooperSeek, LooperSeekAnywhere |
searchStartsWith | - Sorts the Table control according to the specified column, switches the column to search mode and fills the edit control of the column with the characters specified in <Initial Value>.
Versions 21 and laterGeneric search whose type is "Starts with" New in version 21Generic search whose type is "Starts with" Generic search whose type is "Starts with"
| |
taByLogicalOrder | The columns are created according to the logical order of items defined in the data model editor. For the queries, the logical order and the physical order of items are identical. | BuildBrowsingTable |
taCollapse | Node status: The node is collapsed | TableItemStatus |
taColumnDisplayedOrder | Exports the columns according to the order of columns currently displayed in the Table control (and not according to the order of columns defined in the editor). | ConfigureAAF TableToClipboard TableToText TableToWord TableToExcel TableToXML |
taColumnsTitles | Configure the Word/Excel file: inserts the title of columns. | ConfigureAAF TableToClipboard TableToText TableToWord TableToExcel TableToXML LooperToExcel LooperToWord LooperToXML |
taCurrentFirst | Refreshes the Table control (Looper control or List box control) from the current file record. The first row is selected. This row corresponds to the current record. | TableDisplay ListDisplay LooperDisplay |
taCurrentRecord | Refreshes the Table control from the current record in the file:- Re-runs the linked query if necessary.
- Takes into account the records added, modified or deleted by other computers.
- Selects the current record. If the current record is deleted or if it does not correspond to the filter, selects the next record that is not deleted.
- The scrollbar position is stored as long as the selection remains visible.
- Runs the beginning of initialization and the end of initialization, then the selection process of selected row (even if it is not modified).
| TableDisplay TreeDisplay |
taCurrentSelection | Refreshes the Table control (Looper control or List box control) from the current file record. The position of selection bar is not modified. The selected record corresponds to the current record. | TableDisplay ListDisplay LooperDisplay TreeDisplay |
taError | Node status: Node not found Type of element: the element does not exist | TableItemStatus TableTypeItem |
taExpand | Node status: The node is expanded | TableItemStatus |
taFillTable | Fills a memory Table control with the file content. | BuildBrowsingTable |
taFirst | - Child to return: the first child element
Versions 22 and laterPosition in the table: First table element New in version 22Position in the table: First table element Position in the table: First table element
| |
taInit | Re-display the control by running the initialization code. | TableDisplay ListDisplay LooperDisplay TreeDisplay |
taInputAutoId | Input allowed in the column associated with the automatic identifier. | BuildBrowsingTable |
taItemCaption | The column titles correspond to the captions of items typed in the analysis. | BuildBrowsingTable |
taKeepBrowseKey | Search key of BrowsingTable control not modified. | BuildBrowsingTable |
taKeepColumn | Keeps the existing columns. | BuildBrowsingTable |
taLeaf | Type of element: the element is a leaf. | TableTypeItem |
taMerge | Exports the content of Table control and merges the cells with the existing XLS file. The formatting and the existing formulas are kept. The data is not merged. The existing data is not stored. Only the data of columns found as well in the existing XLS file is kept. | TableToExcel LooperToExcel |
taNext | Child to return: the next child Table control to display: the next page Looper control to display: the next page | TableGiveChild TableDisplay LooperDisplay |
taNoAdjust | The width of columns is not adjusted. | BuildBrowsingTable |
taNode | Type of element: the element is a node. | TableTypeItem |
taNoMemoImage | The Image Memo items are not added into the Table control. | BuildBrowsingTable |
taNoMemoText | The Text Memo items are not added into the Table control. | BuildBrowsingTable |
taNoTitle | Configure the Word/Excel file: does not copy the title of columns. | ConfigureAAF TableToClipboard TableToText TableToWord TableToExcel TableToXML LooperToExcel LooperToWord LooperToXML |
taNoTotal | Does not export rows with totals, average or automatic count (these rows are exported by default). | ConfigureAAF TableToClipboard TableToText TableToXML TableToWord TableToExcel |
Versions 15 and latertaNoUpdEditCb New in version 15taNoUpdEditCb taNoUpdEditCb | If the control is an editable Combo Box control, the edit control associated with the Combo Box is not modified according to the new content of the list. If this constant is not used: the edit control of the combo box is modified by default. | ListDisplay |
taNoXSL | The style sheet (".XSL" file) is not created. | TableToXML LooperToXML |
taPrevious | Table control to display: the previous page. Looper control to display: the previous page. | TableDisplay LooperDisplay |
taReExecuteQuery | - Refreshes the Table control (Looper control or List Box control) and positions at the beginning of control.
- The first row is selected. This row corresponds to the first record.
- Re-runs the query linked to the Table control (Looper or List Box control). For more details, see Table controls and queries.
Caution: Only the query linked to the Table control (Looper or List Box) will be run. If specific options have been specified by HExecuteQuery (hModifyFile for example), these options are ignored. | TableDisplay ListDisplay LooperDisplay TreeDisplay |
taSelectedLines | Exports the selected rows (all the rows are exported by default). | ConfigureAAF TableToClipboard TableToText TableToExcel TableToWord TableToXML LooperToExcel LooperToWord LooperToXML |
taStart | Redisplays the Table control (Looper control or List Box control) by positioning on the first record of linked file. The first record is selected. | TableDisplay ListDisplay LooperDisplay TreeDisplay |
Versions 22 and latertaVisible New in version 22taVisible taVisible | position of the row in the table: visible row. | TablePosition |
taWithAutoId | Creates a column for the automatic identifier | BuildBrowsingTable |
taWithBinary | Adds the binary items (link composite key for example) into the Table control. | BuildBrowsingTable |
taWithInvisibleColumns | Exports the invisible columns to the Word or Excel file. | ConfigureAAF TableToClipboard TableToText TableToWord TableToExcel TableToXML |
taWithLayout | Exports the color and font of Table control. | TableToExcel LooperToExcel |
Versions 23 and latertaWithLinkDetails New in version 23taWithLinkDetails taWithLinkDetails | A sub-table is automatically generated to display the records found in the data files linked to the selected row. | BuildBrowsingTable |
tcpCreation | Order of columns: order in which the columns are created. | TableColumnSubscript |
tcpDisplay | Order of columns: order in which the columns are displayed at run time. | TableColumnSubscript |
Versions 16 and latertcsColumn New in version 16tcsColumn tcsColumn | Retrieves the column number. | TableCellSelect |
Versions 16 and latertcsLine New in version 16tcsLine tcsLine | Retrieves the row number. | TableCellSelect |
tiColName | Type of information to return: name of column. | TableInfoXY |
tiColNumber | Type of information to return: creation subscript of column. | TableInfoXY |
tiLineNumber | Type of information to return: row subscript. | TableInfoXY |
tiOriginScreen | Modifies the origin used. By default, (0,0) corresponds to row 1, column 1 (the scrollbars being located at the origin). If tiOriginScreen is used, (0,0) corresponds to the origin of the screen. | TableInfoXY |
Versions 18 and latertmInChild New in version 18tmInChild tmInChild | Type of move: The branch is moved and it will be the first child of destination branch. The branch moved will be positioned one level below the destination branch in the hierarchy. | TableMoveBranch |
Versions 18 and latertmInSibling New in version 18tmInSibling tmInSibling | Type of move: The branch is moved and it will be the next sibling of the destination branch. The branch moved will be positioned on the same hierarchy level as the destination branch but at the following position. | TableMoveBranch |
toColumn | Element taken into account: number of columns in the Table control, number of attributes in the Looper control. | TableCount LooperCount |
toShown | Element taken into account:- number of non-empty rows visible in the Table control,
- number of non-empty rows visible in the Looper control,
Versions 19 and laternumber of Widgets visible in a Dashboard control. New in version 19number of Widgets visible in a Dashboard control. number of Widgets visible in a Dashboard control.
| TableCount LooperCount DashCount |
toTotal | - Browsing Table control:
- Total number of records in the linked file (filtered or not)
- Number of visible records (Table control with continuous scrollbar)
- Memory Table control: number of rows in memory
- Browsing Looper control: total number of records
- Memory Looper control: number of rows in memory
Versions 19 and laterDashboard control: total number of Widgets New in version 19Dashboard control: total number of Widgets Dashboard control: total number of Widgets
| TableCount LooperCount DashCount |
toVisible | Elements taken into account: maximum number of rows visible in the Table control or in the Looper control. | TableCount LooperCount |
Versions 16 and latertsCell New in version 16tsCell tsCell | Element taken into account: Number of selected cells. | TableSelectCount |
Versions 16 and latertsCellColumn New in version 16tsCellColumn tsCellColumn | Element taken into account: Number of the column for the cell selected in the Table control. | TableSelect |
Versions 16 and latertsCellLine New in version 16tsCellLine tsCellLine | Element taken into account: Number of the row for the cell selected in the Table control. | TableSelect |
Versions 16 and latertsColumn New in version 16tsColumn tsColumn | Element taken into account:- Number of the selected column.
- Number of selected columns.
| TableSelect TableSelectCount |
Versions 16 and latertsRow New in version 16tsRow tsRow | Element taken into account:- Number of the selected row.
- Number of selected rows.
| TableSelect TableSelectCount |
WithAll | Configure the print of a Table control: Prints the table while taking all the options into account (corresponds to WithMultipageColumns + WithDate + WithNbRecords + WithNbPages + WithTitle) | TablePrint |
WithDate | Configure the print of a Table control: the date is printed at the top of page. | TablePrint |
WithMultipageColumns | Configure the print of a Table control: if the Table control exceeds the page size, the columns are printed over several pages. | TablePrint |
WithNbPages | Configure the print of a Table control: the number of pages is printed at the end of page. | TablePrint |
WithNbRecords | Configure the print of a Table control: the number of records is printed at the end of document. The caption used corresponds to the caption defined for the counter (in the description of Table control). | TablePrint |
WithTitle | Configure the print of a Table control: the page title is printed at the top of page. If the title of Table control is not visible, prints the window title. | TablePrint |