GridView.RefreshScrollAnnotations(ScrollAnnotationKind, Int32[]) Method

Updates scrollbar annotations of the specified kind for the specified rows, and causes them to be redrawn.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v24.2.dll

Declaration

C#

public virtual void RefreshScrollAnnotations(
    ScrollAnnotationKind kind,
    int[] rows
)

VB.NET

Public Overridable Sub RefreshScrollAnnotations(
    kind As ScrollAnnotationKind,
    rows As Integer()
)

Parameters

Name	Type	Description
kind	DevExpress.XtraEditors.Annotations.ScrollAnnotationKind	The kind of scrollbar annotations to update.
rows	Int32[]	An array of row handles.

Remarks

The code below updates custom scrollbar annotations for all rows.

C#

bool ToggleBookmark(int handle) {
    int dataIndex = gridView.GetDataSourceRowIndex(handle);
    if(dataIndex < 0)
        return false;
    if(bookmarks.Contains(dataIndex))
        bookmarks.Remove(dataIndex);
    else
        bookmarks.Add(dataIndex);
    gridView.RefreshScrollAnnotations(ScrollAnnotationKind.Custom);
    gridView.InvalidateRow(handle);
    return true;
}

VB.NET

Private Function ToggleBookmark(ByVal handle As Integer) As Boolean
    Dim dataIndex As Integer = gridView.GetDataSourceRowIndex(handle)
    If dataIndex < 0 Then
        Return False
    End If
    If bookmarks.Contains(dataIndex) Then
        bookmarks.Remove(dataIndex)
    Else
        bookmarks.Add(dataIndex)
    End If
    gridView.RefreshScrollAnnotations(ScrollAnnotationKind.Custom)
    gridView.InvalidateRow(handle)
    Return True
End Function

Note

Run the Scrollbar Annotations & Bookmarks module in the XtraGrid MainDemo to see the complete example.