List view items

Each item in the list view has the following attributes:

Index   The index is a long integer that specifies the position of the item in the list. You will use the index whenever you reference a list item from sanScript.

Be aware that the index value of a list item may change. For example, when the list is re-sorted, an item may appear in a different location in the list. Thus, its index value will have changed.


Label   The label is the text that appears with the item.

Data item   Each item has a long integer value associated with it that you can use to store data specific to the item.

Images   Each item can have several images associated with it. One image is used as the icon displayed with the item. Additional images can be used to “overlay” the icon image. Still other images can be used to show the state of an item. Use of images in list views is discussed in detail in Image types for list views.

Subitems   Each list view item can have several subitems associated with it. A subitem typically consists of a single string value. Subitems can be displayed when the list view is shown in report view mode. They are not shown in the other view modes. Each subitem can also have an additional currency, date, time or integer component that stores a value to be used for sorting the contents of the list.

By default, a list view will use the string component of a subitem when sorting a column in the list view. The list view items will be sorted in ASCII order, which may not be appropriate if the column contains currency, integer, date or time values. If the subitems in the column have an additional currency, integer, date or time component, these additional components will be used to sort the list.

If a subitem has an additional currency, integer, date or time component, but no string component, the additional component will be displayed in report view mode.


Documentation Feedback