Skip to main content

TcxGridPopulateCustomScrollbarAnnotationRowIndexList Type

The custom scrollbar annotation display event type.

Declaration

TcxGridPopulateCustomScrollbarAnnotationRowIndexList = procedure(Sender: TcxCustomGridTableView; AAnnotationIndex: Integer; ARowIndexList: TdxScrollbarAnnotationRowIndexList) of object;

Parameters

Name Type
Sender TcxCustomGridTableView
AAnnotationIndex Integer
ARowIndexList TdxScrollbarAnnotationRowIndexList

Remarks

The Sender parameter provides access to the grid View that raised a TcxGridPopulateCustomScrollbarAnnotationRowIndexList event.

Use the AAnnotationIndex parameter to identify a custom annotation whose marks the grid View is about to display on its scrollbar. Different annotations should have different scrollbar mark display criteria.

The ARowIndexList parameter defines the list of records marked with the custom annotation whose index is AAnnotationIndex. Call the ARowIndexList.Add procedure to add a custom scrollbar annotation mark to the record that meets any required criteria.

A grid View’s OnPopulateCustomScrollbarAnnotationRowIndexList event references the TcxGridPopulateCustomScrollbarAnnotationRowIndexList type. Refer to this event description for additional information and a code example.

See Also