BandedGridView.CanDragBand(GridBand) Method

Indicates whether a band can be dragged by end-users.

Namespace : DevExpress.XtraGrid.Views.BandedGrid

Assembly : DevExpress.XtraGrid.v25.2.dll

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

Declaration

C#
VB.NET

csharp

public virtual bool CanDragBand(
    GridBand band
)

Public Overridable Function CanDragBand(
    band As GridBand
) As Boolean

Parameters

Name	Type	Description
band	GridBand

A GridBand object representing the inspected band.

Returns

Type	Description
Boolean

true if end-users can drag the band; otherwise, false.

Remarks

The method’s return value depends on the band’s OptionsBand.AllowMove option. The option specifies whether end-users can drag the band header to re-order bands. Note that band dragging by end-users is also controlled by the band’s OptionsBand.AllowPress option. If this option is disabled, end-users cannot drag the band regardless of the OptionsBand.AllowMove option setting. Thus, the CanDragBand method can return true while the band dragging is actually unavailable to end-users.

This function supports the grid’s internal infrastructure and is not intended to be called from your code.