| | |
| 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) does not change.
This constant can be combined with the amMove and amSwap constants. | <Table>.MoveLine
<List box>.MoveLine
<Looper>.MoveLine |
| amFirst | Row movement: Moves the row to the first position. | <Table>.MoveLine
<List box>.MoveLine
<Looper>.MoveLine |
| amLast | Row movement: Moves the row to the last position. | <Table>.MoveLine
<List box>.MoveLine
<Looper>.MoveLine |
| amMove | Row movement: Moves the row to the index of the destination row. | <Table>.MoveLine
<List box>.MoveLine
<Looper>.MoveLine |
| amNext | Row movement: Moves the row one position downwards. | <Table>.MoveLine
<List box>.MoveLine
<Looper>.MoveLine |
| 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). | <Table>.MoveLine
<List box>.MoveLine
<Looper>.MoveLine |
| amPrevious | Row movement: Moves the row one position upwards. | <Table>.MoveLine
<List box>.MoveLine
<Looper>.MoveLine |
| 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). | <Table>.MoveLine
<List box>.MoveLine
<Looper>.MoveLine |
| amSwap | Row movement: The source and destination rows are swapped. | <Table>.MoveLine
<List box>.MoveLine
<Looper>.MoveLine |
| filterContains | Displays the rows whose value for the specified column "Contains" the specified characters. | TableEnableFilter,
<Table column>.InputSearch,
MagnifierMode property
<Edit>.ConfigureAssistedInput |
| filterDifferent | Displays the rows whose value for the specified column "differs" from the specified characters. | TableEnableFilter,
<Table column>.InputSearch,
MagnifierMode property
<Edit>.ConfigureAssistedInput |
| filterDoesNotContain | Displays the rows whose value for the specified column "does not contain" the specified characters. | TableEnableFilter,
<Table column>.InputSearch,
MagnifierMode property
<Edit>.ConfigureAssistedInput |
| filterDoesNotEndWith | Displays the rows whose value for the specified column "does not end with" the specified characters. | TableEnableFilter,
<Table column>.InputSearch,
MagnifierMode property
<Edit>.ConfigureAssistedInput |
| filterDoesNotStartWith | Displays the rows whose value for the specified column "Does not start with" the specified characters. | TableEnableFilter,
<Table column>.InputSearch,
MagnifierMode property
<Edit>.ConfigureAssistedInput |
| filterEndsWith | Displays the rows whose value for the specified column "ends with" the specified characters. | TableEnableFilter,
<Table column>.InputSearch,
MagnifierMode property
<Edit>.ConfigureAssistedInput |
| filterEqual | Displays the rows whose value for the specified column "is equal" to the specified characters. | TableEnableFilter,
<Table column>.InputSearch,
MagnifierMode property
<Edit>.ConfigureAssistedInput |
| filterGreater | Displays the rows whose value for the specified column "is greater than" the specified characters. | TableEnableFilter,
<Table column>.InputSearch,
MagnifierMode property
<Edit>.ConfigureAssistedInput |
| filterGreaterOrEqual | Displays the rows whose value for the specified column "is greater than or equal to" the specified characters. | TableEnableFilter,
<Table column>.InputSearch,
MagnifierMode property
<Edit>.ConfigureAssistedInput |
| filterLess | Displays the rows whose value for the specified column "is less" than the specified characters | TableEnableFilter,
<Table column>.InputSearch,
MagnifierMode property
<Edit>.ConfigureAssistedInput |
| filterLessOrEqual | Displays the rows whose value for the specified column "is less than or equal to" the specified characters. | TableEnableFilter,
<Table column>.InputSearch,
MagnifierMode property
<Edit>.ConfigureAssistedInput |
| filterNone | Disables the automatic filter used by the assisted input. The filter must be performed manually. | <Edit>.ConfigureAssistedInput |
| filterStartsWith | Displays the rows whose value for the specified column "Starts with" the specified characters. | TableEnableFilter,
<Table column>.InputSearch,
MagnifierMode property
<Edit>.ConfigureAssistedInput |
| 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 |
| rowMaximum | Used to handle the row corresponding to an automatic calculation (Maximum type). | Automatic calculations in the tables |
| 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. | <List box>.MoveLine
<Table>.MoveLine
<Looper>.MoveLine |
| searchContains | Generic search whose type is "Contains" | TableSearch,
<Looper>.SearchEverywhere |
| searchDefault | - Sorts the Table control according to the specified column and switches the column to search mode.
- Exact-match search whose type is "Equals to".
| <Table column>.InputSearch,
MagnifierMode property,
TableSearch |
| searchExactMatch | Exact-match search (whose type is "Equals to") | TableSearch,
<Looper>.SearchEverywhere |
| 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;;>.
- Generic search whose type is "Starts with"
| <Table column>.InputSearch,
MagnifierMode property,
TableSearch,
<Looper>.SearchEverywhere |
| 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 | <TreeView Table>.ItemStatus |
| 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
<Looper>.ToExcel
<Looper>.ToWord
<Looper>.ToXML |
| 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. | <Table>.Display
<List box>.Display
<Looper>.Display |
| 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).
| <Table>.Display
<TreeView>.Display |
| 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. | <Table>.Display
<List box>.Display
<Looper>.Display
<TreeView>.Display |
| taError | Node status: Node not found
Type of element: the element does not exist | <TreeView Table>.ItemStatus
<TreeView Table>.TypeItem |
| taExpand | Node status: The node is expanded | <TreeView Table>.ItemStatus |
| taFillTable | Fills a Table control populated programmatically with the file content. | BuildBrowsingTable |
| taFirst | - Child to return: the first child element
- Position in the table: First table element
| <TreeView Table>.GiveChild,
<Table>.Position |
| taInit | Re-display the control by running the initialization code. | <Table>.Display
<List box>.Display
<Looper>.Display
<TreeView>.Display |
| taItemCaption | The column titles correspond to the captions of items typed in the analysis. | BuildBrowsingTable |
| taKeepBrowseKey | The search key of a Table control based on a data file does not change. | BuildBrowsingTable |
| taKeepColumn | Keeps the existing columns. | BuildBrowsingTable |
| taLeaf | Type of element: the element is a leaf. | <TreeView Table>.TypeItem |
| 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
<Looper>.ToExcel |
| taMultiLineColumn | By default, text columns are created with the Multiline property set to True. | BuildBrowsingTable |
| taNext | Child to return: the next child
Table control to display: the next page
Looper control to display: the next page | <TreeView Table>.GiveChild
<Table>.Display
<Looper>.Display |
| taNoAdjust | The width of columns is not adjusted. | BuildBrowsingTable |
| taNode | Type of element: the element is a node. | <TreeView Table>.TypeItem |
| taNoMemoImage | Image Memo items are not added to the Table control. | BuildBrowsingTable |
| taNoMemoText | Text Memo items are not added to the Table control. | BuildBrowsingTable |
| taNoTitle | Configure the Word/Excel file: does not copy the title of columns. | ConfigureAAF
TableToClipboard
TableToText
TableToWord
TableToExcel
TableToXML
<Looper>.ToExcel
<Looper>.ToWord
<Looper>.ToXML |
| taNoTotal | Does not export rows with totals, average or automatic count (these rows are exported by default). | ConfigureAAF
TableToClipboard
TableToText
TableToXML
TableToWord
TableToExcel |
| 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. | <List box>.Display |
| taNoXSL | The style sheet (".XSL" file) is not created. | TableToXML
<Looper>.ToXML |
| taPrevious | Table control to display: the previous page.
Looper control to display: the previous page. | <Table>.Display
<Looper>.Display |
| 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 with HExecuteQuery (hModifyFile, for example), these options are ignored. | <Table>.Display
<List box>.Display
<Looper>.Display
<TreeView>.Display |
 New in version SaaStaRefreshIndicatorDown | Determines whether or not a wait indicator is displayed when the table is refreshed from the bottom. | <Table>.AddInProgress, <Looper>.AddInProgress |
New in version SaaStaRefreshIndicatorUp | Determines whether or not a wait indicator is displayed when the table is refreshed from the top. | <Table>.AddInProgress, <Looper>.AddInProgress |
| taSelectedLines | Exports the selected rows (all the rows are exported by default). | ConfigureAAF
TableToClipboard
TableToText
TableToExcel
TableToWord
TableToXML
<Looper>.ToExcel
<Looper>.ToWord
<Looper>.ToXML |
| taSingleLineColumn | By default, text columns are created with the Multiline property set to False. | BuildBrowsingTable |
| 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. | <Table>.Display
<List box>.Display
<Looper>.Display
<TreeView>.Display |
| taVisible | position of the row in the table: visible row. | <Table>.Position |
| taWithAutoID | Creates a column for the automatic identifier | BuildBrowsingTable |
| taWithAutoID | Input allowed in the column associated with the automatic identifier. | BuildBrowsingTable |
| taWithBinary | Adds the binary items (link composite key for example) into the Table control. | BuildBrowsingTable |
| taWithDetailsBinding | A sub-table is automatically generated to display the records found in the data files linked to the selected row. | 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
<Looper>.ToExcel |
| tcpCreation | Order of columns: order in which the columns are created. | <Table>.ColumnIndex |
| tcpDisplay | Order of columns: order in which the columns are displayed at run time. | <Table>.ColumnIndex |
| tcsColumn | Retrieves the column number. | <Table>.CellSelect |
| tcsLine | Retrieves the row number. | <Table>.CellSelect |
| tiColName | Type of information to return: column name. | <Table>.InfoXY |
| tiColNumber | Type of information to return: column creation index. | <Table>.InfoXY |
| tiLineNumber | Type of information to return: row index. | <Table>.InfoXY |
| tiOnButtonCollapseExpand | Type of information to return: The coordinates correspond to the "+/-" buttons used to expand and collapse a row in a TreeView Table control. | <Table>.InfoXY |
| 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. | <Table>.InfoXY |
| 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. | <TreeView Table>.MoveBranch |
| 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. | <TreeView Table>.MoveBranch |
| toColumn | Element taken into account: number of columns in the Table control, number of attributes in the Looper control. | <Table>.Count
<Looper>.Count |
| 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,
- number of Widgets visible in a Dashboard control.
| <Table>.Count
<Looper>.Count
DashCount |
| toTotal | - Table control based on a data file:
- Total number of records in the linked file (filtered or not)
- Number of visible records (Table control with continuous scrollbar)
- Table control populated programmatically: number of rows in memory
- Looper control based on a data file: total number of records
- Looper control populated programmatically: number of rows in memory
- Dashboard control: total number of widgets
| <Table>.Count
<Looper>.Count
DashCount |
| toVisible | Elements taken into account: maximum number of rows visible in the Table control or in the Looper control. | <Table>.Count
<Looper>.Count |
| tsCell | Element taken into account: Number of selected cells. | <Table>.SelectCount |
| tsCellColumn | Element taken into account: Number of the column for the cell selected in the Table control. | <Table>.Select |
| tsCellRow | Element taken into account: Number of the row for the cell selected in the Table control.
| <Table>.Select |
| tsColumn | Element taken into account:- Number of the selected column.
- Number of selected columns.
| <Table>.Select
<Table>.SelectCount |
| tsRow | Element taken into account:- Number of the selected row.
- Number of selected rows.
| <Table>.Select
<Table>.SelectCount |
| 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) | <Table>.Print |
| WithDate | Configure the print of a Table control: the date is printed at the top of page. | <Table>.Print |
| WithMultipageColumns | Configure the print of a Table control: if the Table control exceeds the page size, the columns are printed over several pages. | <Table>.Print |
| WithNbPages | Configure the print of a Table control: the number of pages is printed at the end of page. | <Table>.Print |
| 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 Table control description). | <Table>.Print |
| 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. | <Table>.Print |