The IliTableGadget class enables you to display an entire table. It also lets the end user edit table values, and add or delete rows.

A table gadget can be connected to a data source by calling f_setDataSourceName.

The IliTableGadget class provides many member functions that allow you to control the look of the gadget.

The IliTableSelection class is used to describe the highlighted area in a table gadget at a given point in time. This area can be any of the following:

The getSelection member function returns the current selection in a table gadget and the setSelection changes this selection.

By default, a table gadget is bound to its data source. This means that the row of the selection in the table gadget remains synchronized with the current row of the data source. The bindToDataSource member function controls this.

The pointToSelection member function can be used to identify which part of a table gadget contains a given geometrical point.

The table gadget event handler lets the end user resize the columns and change their order. If there is more than one table gadget connected to the same data source, resizing a column in one of them will also resize the column in the others (by default). This is because the size and order of columns are stored in the table object of the data source and the data source is shared by the table gadgets.

The table gadget supports a special mode in which column size, visibility, and order are local to the table gadget itself and independent of other table gadgets connected to the same data source. The setColumnsGeometryLocal member function can be used to activate this mode. See Setting the Table Look.

Note that when column geometry is local, the index of a column can be different in the table gadget and the underlying table. The getRealColno and getVisualColno member functions can be used to convert a column index between the table gadget order and the underlying table object order.

Table gadget cells can be edited with editors that are managed by the table gadget. Each column in a table gadget has an editor. By default, a table gadget creates the editor for each column depending on the column data type and mapping.

For columns with a foreign column, the table gadget creates an IliTableComboBox. For other columns, it creates an IliEntryField.

The setColumnEditor can be used to define a custom editor for a given column.

Table gadgets can be customized with callbacks.

The GetCellPalette callback can be used to change the foreground and background colors, and the font, cell by cell.

Here is an example:

Note that colors defined through a GetCellPalette callback are dynamic. The table gadget does not keep a record of the colors for a cell. Instead, it calls the GetCellPalette callback each time it needs to draw the cell.

Note that another technique is available to define colors on a row, a column, or a cell basis. See Table Properties for more information.

The DrawCell callback can be used to provide a custom draw procedure for some of the cells in a table gadget. Here is an example:

You can change the column editor of a table gadget. For example, columns with a data type like Boolean, can replace the Yes/No combo box by a toggle without a label (class IliSimpleToggle).