GridView.CustomScrollAnnotation Event

Allows you to specify custom annotations.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v22.1.dll

NuGet Package: DevExpress.Win.Grid

Declaration

C#

[DXCategory("Events")]
public event EventHandler<GridCustomScrollAnnotationsEventArgs> CustomScrollAnnotation

VB.NET

<DXCategory("Events")>
Public Event CustomScrollAnnotation As EventHandler(Of GridCustomScrollAnnotationsEventArgs)

Event Data

The CustomScrollAnnotation event's data class is DevExpress.XtraGrid.Views.Grid.GridCustomScrollAnnotationsEventArgs.

Remarks

The CustomScrollAnnotation event allows you to provide data about required custom annotations. Data is represented by the GridScrollAnnotationInfo type that exposes the following properties:

• RowHandle — handle of the required row (see Row handles in the Rows topic);
• Color — color of the mark on the scrollbar.

When handling the CustomScrollAnnotation event, explicitly initialize the e.Annotations collection, create data objects, and add them to the collection.

C#

using using DevExpress.XtraGrid.Views.Grid;

void OnCustomScrollAnnotation(object sender, GridCustomScrollAnnotationsEventArgs e) {
    e.Annotations = new List<GridScrollAnnotationInfo>();
    GridScrollAnnotationInfo info = new GridScrollAnnotationInfo() { RowHandle = 74, Color = Color.Red };
    e.Annotations.Add(info);
}

VB.NET

Imports using DevExpress.XtraGrid.Views.Grid

Private Sub OnCustomScrollAnnotation(ByVal sender As Object, ByVal e As GridCustomScrollAnnotationsEventArgs)
    e.Annotations = New List(Of GridScrollAnnotationInfo)()
    Dim info As New GridScrollAnnotationInfo() With {.RowHandle = 74, .Color = Color.Red}
    e.Annotations.Add(info)
End Sub

You can also use the e.SetAnnotations method to set annotations for a row array.

C#

void OnCustomScrollAnnotation(object sender, GridCustomScrollAnnotationsEventArgs e) {
    int[] rowHandles = new int[] { 5, 17, 74 };
    e.SetAnnotations(Color.Red, rowHandles);
}

VB.NET

Private Sub OnCustomScrollAnnotation(ByVal sender As Object, ByVal e As GridCustomScrollAnnotationsEventArgs) Handles gridView.CustomScrollAnnotation
    Dim rowHandles() As Integer = {5, 17, 74}
    e.SetAnnotations(Color.Red, rowHandles)
End Sub

Use the RefreshScrollAnnotations method to force the grid control to update/redraw scrollbar annotations.