The SDL Component Suite is an industry leading collection of components supporting scientific and engineering computing. Please visit the SDL Web site for more information....

How to use TReportListView

The report list component is based on the TRLData class which provides the data model of the component. The number of visible rows and columns is determined by the properties NrOfRows and NrOfColumns. In addition to the visible string cells, each row has one invisible cell (column index 0) which can be used to store additional hidden information in the report list. The cells of the report list can be accessed via the property Elem which is the default property. The headers of the columns can be adjusted by using the property Header. The methods AddRow and RemoveRow can be used to add an additional empty row to the end of the report list, and to remove a particular row from the list. By default, all cells of the report list view are read-only. However, the report list view can be switched columnwise into an editable mode by setting the array property ColumnEditable.

Before storing more than a few strings, it is recommended to set the property SuppressPaint to TRUE in order to prevent repeated repaint events. Otherwise, loading the report list will be extremely slow.

The rows of the report list may be sorted according to any column (including the hidden column 0) by using the method Sort. The method UnSort re-establishes the original order of the rows. Rows may also be sorted interactively by clicking on the corresponding header field if the property SortEnabled is set TRUE.

The visual appearance can be adjusted by the color properties ColorText, ColorBkgdNormal, and ColorBkgdShaded. The property RowColPattern determines the pattern of shaded and normal rows. Note that there are some additional parameters covered by the property Options which may also affect the visual appearance of the report list. Any column of the report list may also be set up as a checked column (strings with a check box or a radio button left to it) by setting the property ColumnCheckMode accordingly. The check boxes may be ticked off either by clicking them or programmatically by using the property ElemChecked.

The rows of the list view can be disabled on an individual basis by using the array property RowEnabled. Disabled rows are displayed in different colors (ColorDisabledText, ColorDisabledBkgd) and cannot be edited by the inplace editor, nor can any associated check boxes be ticked off.

For special purposes the container which holds the strings of the report list may be accessed directly by using the public variable FRLData.Strings (not recommended for inexperienced users).

Last Update: 2023-Feb-06