GridView.OptionsScrollAnnotations Property

Provides access to options specific to scrollbar annotations.

Namespace : DevExpress.XtraGrid.Views.Grid

Assembly : DevExpress.XtraGrid.v25.2.dll

NuGet Packages : DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#
VB.NET

csharp

[DXCategory("Options")]
[XtraSerializableProperty(XtraSerializationVisibility.Hidden, XtraSerializationFlags.DefaultValue)]
public GridOptionsScrollAnnotations OptionsScrollAnnotations { get; }

<DXCategory("Options")>
<XtraSerializableProperty(XtraSerializationVisibility.Hidden, XtraSerializationFlags.DefaultValue)>
Public ReadOnly Property OptionsScrollAnnotations As GridOptionsScrollAnnotations

Property Value

Type	Description
DevExpress.XtraGrid.Views.Grid.GridOptionsScrollAnnotations

A DevExpress.XtraGrid.Views.Grid.GridOptionsScrollAnnotations object specifying options specific to scrollbar annotations.

Remarks

The GridView.OptionsScrollAnnotations property provides access to options that allow you to enable/disable specific annotations.

ShowErrors — specifies whether to mark rows with validation errors
ShowFocusedRow — specifies whether to mark the focused row
ShowSelectedRows — specifies whether to mark selected rows
ShowCustomAnnotations — specifies whether to mark rows with custom annotations provided using a dedicated event (see GridView.CustomScrollAnnotation)

Scrollbar annotations are disabled if the corresponding property is set to Default. You should explicitly set the options to True to enable the required scrollbar annotations.

C#
VB.NET

csharp

// Enable annotations for the focused row.
gridView.OptionsScrollAnnotations.ShowFocusedRow = DefaultBoolean.True;

' Enable annotations for the focused row.
gridView.OptionsScrollAnnotations.ShowFocusedRow = DefaultBoolean.True

Scrollbar annotations have the following limitations:

lookup editors (see GridLookUpEdit, SearchLookUpEdit) do not support scrollbar annotations for search requests in the Find Panel;
scrollbar annotations for validation errors and search requests are not supported in the Server Mode;
scrollbar annotations for selected rows are only supported in the multiple row selection mode (see ColumnViewOptionsSelection.MultiSelect).