Class GridQueryAllowSortColumnEventArgs

Holds a reference to a GridTableControl that initiates the event and the column that is affected.

Inheritance

System.Object

System.EventArgs

SyncfusionEventArgs

GridQueryAllowSortColumnEventArgs

Inherited Members

SyncfusionEventArgs.ToString()

System.EventArgs.Empty

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Syncfusion.Windows.Forms.Grid.Grouping

Assembly: Syncfusion.Grid.Grouping.Windows.dll

Syntax

public sealed class GridQueryAllowSortColumnEventArgs : SyncfusionEventArgs

Remarks

Set AllowSort to False if you do not want to allow the user to by clicking on the specified Column.

Constructors

GridQueryAllowSortColumnEventArgs(GridTableControl, GridColumnDescriptor, GridCellClickEventArgs)

Initializes the event args.

Declaration

public GridQueryAllowSortColumnEventArgs(GridTableControl tableControl, GridColumnDescriptor column, GridCellClickEventArgs cellClickEventArgs)

Parameters

Type	Name	Description
GridTableControl	tableControl	The table control.
GridColumnDescriptor	column	Column Descriptor.
GridCellClickEventArgs	cellClickEventArgs	A GridCellClickEventArgs.

Properties

AllowSort

Set AllowSort to False if you do not want to allow the user to sort by clicking on the specified Column.

Declaration

public bool AllowSort { get; set; }

Property Value

Type
System.Boolean

CellClickEventArgs

Gets the underlying GridCellClickEventArgs that triggered the QueryAllowSortColumn event. You can check the CellClickEventArgs to find out which mouse button was clicked or the exact position of the mouse pointer.

Declaration

public GridCellClickEventArgs CellClickEventArgs { get; }

Property Value

Type
GridCellClickEventArgs

Column

Column Descriptor.

Declaration

[TraceProperty(true)]
public GridColumnDescriptor Column { get; }

Property Value

Type
GridColumnDescriptor

TableControl

The table control.

Declaration

[TraceProperty(true)]
public GridTableControl TableControl { get; }

Property Value

Type
GridTableControl