Object: XTable
- Updated2024-09-12
- 4 minute(s) read
(Controls | Controls | Dialog Box) > Object: XTable
Object: XTable
The XTable object corresponds to the XTable control in a user dialog box. You use the XTable object to define an extended table that is to be displayed in the user dialog box.
You can label the columns and rows of the extended table with Text type headings. The user dialog box displays these headings in row 0 or in column 0. The actual data in the extended table starts at row 1 and column 1.
In the Configure Columns dialog box you assign a cell type to each column of the extended table. The cell type specifies what type of control is assigned to a column. Possible cell types for the extended table are Button <XTable>, CheckBox<XTable>, ChnComboBox<XTable>, ChnListBox<XTable>, ComboBox<XTable>, EditBox<XTable>, ListBox<XTable> and Text<XTable>.
Two controls of the selected type are always assigned to a column in the extended table. The user dialog box uses the first control in the display mode of the extended table and the second control in the entry mode.
Unlike the controls that are displayed in the table, the extended table controls are not linked to variables. Instead, the contents of the controls are controlled by events, which enable you all kinds of display in the extended table. The display mode and the entry mode in the extended table enable you to react dynamically to specific requirements when table contents are displayed. For example, you can define different colors and formats for displaying and entering table values.
Use the events EventValGet and EventValSet to control the contents of the extended table. The user dialog box triggers the EventValSet event to save the value of a cell from the extended table. The user dialog box uses the EventValGet event to display a value in a cell of the extended table. Due to this architecture the extended table never has data but offers an extraordinary flexibility instead.
Inside the Configure Columns dialog box you also can specify a <Default> cell type. Use this cell type to facilitate and to speed up the definition of large matrices in the extended table.
Use the Cell Type dialog box to configure the properties of the controls for the display mode and the entry mode. The properties list in this dialog box shows only the control properties that are useful in the display mode or in the entry mode in the extended table. Use the events EventColCtrlPreset and EventDefaultColCtrlPreset to initialize the controls in the script context.
The following example moves the enabled cell in the extended table XTable1 by one column and one row:
Call XTable1.SetActiveCell(XTable1.ActiveCellRow+1, XTable1.ActiveCellCol+1)
Properties
ActiveCellCol | ActiveCellRow | BackColor | Bottom | CellCtrlAutoReset | Columns | ColumnTitlesDisplay | ColumnTitlesHeight | Enable | GridLinesHorz | GridLinesVert | Height | HorizontalScroll | LastVisibleCol | LastVisibleRow | Left | LeftCol | LockUpdate | ObjectCode | ObjectType | ReadOnly | Right | RowCount | RowHeight | RowTitlesDisplay | RowTitlesWidth | SelectedElements | TabStop | Tag | Top | TopRow | VerticalScroll | Visible | Width
Properties Only Available on the Properties Tab
ActiveCellBorder | ColumnsFrozen | ColWidthMode | CursorPointer | EnterKeyAction | Flex | GridLineFrozenHorz | GridLineFrozenVert | Layer | RowsFrozen | Selection
Methods
GetIdealRowHeight | LayerName | MergeCells | Move | Refresh | RefreshCols | RefreshRows | RunColCtrlPreset | RunCustomAction | RunDefaultColCtrlPreset | RunInitialize | ScrollCellInView | SetActiveCell | SetFocus
Events
EventActionDel | EventActiveCellMoved | EventCellClick | EventClpCopy | EventClpCut | EventClpPaste | EventColCtrlPreset | EventContextMenuPointSelected | EventContextMenuShowing | EventCustomAction | EventDefaultColCtrlPreset | EventDrop | EventDropAllowed | EventInitialize | EventLostFocus | EventRefresh | EventSelChanged | EventToolTipShow | EventValChanged | EventValGet | EventValSet
Returned From
Controls.Item | Dialog <NonModal>.GetControl | Dialog.GetControl
See Also
Columns | SelectedElements | Object Overview
Procedures
Checking a User Dialog Box Entry | Creating a Dynamic User Dialog Box | Creating a Procedure in the Script of a User Dialog Box | Creating a User Dialog Box without Linking Variables | Creating an Extended Table | Displaying Graphics in Selection Lists | Enabling Controls | Responding to User Entries in User Dialog Boxes | Saving and Restoring the Last Dialog Box Position | Saving Control Groups for User Dialog Boxes | Specifying the Default Button | Tabulator Order in a User Dialog Box | Using a Script to Fill a Selection List | Using Channel Selection Lists | Using Hotkeys in a User Dialog Box | Using the Flex Properties
Examples
Checking Dialog Box Entries | Dynamic User Dialog Box | Translating User Dialog Boxes | User Dialog Box for Entering Text and Numbers | User Dialog Box for Sequence Control | User Dialog Box in DIAdem VIEW | User Dialog Box in VIEW for the Calculation of the FFT and Harmonic Frequencies | User Dialog Box with Changing Background Color | User Dialog Box with Curve Preview and Slider Control | User Dialog Box with Extended Table | User Dialog Box with Internet Explorer | User Dialog Box with Scalable Table | User Dialog Box with Selection Lists | User Dialog Box with Selection Lists | User Dialog Box with Subdialog Boxes | User Dialog Box with Tables | User Dialog Box with Tree | Wizard for Tolerance Evaluation