TcxCustomGridTableView.GoToNextScrollbarAnnotation(TdxScrollbarAnnotationKinds,Boolean,Boolean) Method

Moves focus to the nearest record marked with a scrollbar annotation.

Declaration

function GoToNextScrollbarAnnotation(AKinds: TdxScrollbarAnnotationKinds = dxAllScrollbarAnnotationKinds; AGoForward: Boolean = True; AGoOnCycle: Boolean = False): Boolean;

Parameters

Name	Type
AKinds	TdxScrollbarAnnotationKinds
AGoForward	Boolean
AGoOnCycle	Boolean

Returns

Type
Boolean

Remarks

Call this function to navigate between all scrollbar annotation marks. A GoToNextScrollbarAnnotation function call moves focus to the next marked record and scrolls content to display the focused record. The function returns False if the focus position has not changed; otherwise – GoToNextScrollbarAnnotation returns True.

You can pass a custom set of scrollbar annotation types as the AKinds optional parameter to navigate only between them.

Pass False as the AGoForward optional parameter to move focus in the opposite direction.

The AGoOnCycle optional parameter defines if the GoToNextScrollbarAnnotation function moves focus to the first annotated record if the last marked record has focus. Pass True as this parameter to cycle the navigation indefinitely.