Skip to main content

TableView.ScrollBarAnnotationsCreating Event

Allows creating a set of predefined scrollbar annotations.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v23.2.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

public event ScrollBarAnnotationsCreatingEventHandler ScrollBarAnnotationsCreating

Event Data

The ScrollBarAnnotationsCreating event's data class is ScrollBarAnnotationsCreatingEventArgs. The following properties provide information specific to this event:

Property Description
CustomScrollBarAnnotations Gets or sets a set of objects that correspond to predefined scrollbar annotations.
Handled Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
OriginalSource Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEvent Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
Source Gets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.

The event data class exposes the following methods:

Method Description
InvokeEventHandler(Delegate, Object) When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object) When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.

Remarks

Use the ScrollBarAnnotationsCreating event to create predefined scrollbar annotations. In the ScrollBarAnnotationsCreating‘s event handler, pass a set of rows with corresponding annotations to event arguments ScrollBarAnnotationsCreatingEventArgs.CustomScrollBarAnnotations property.

See Also