Class GridQueryAllowGroupByColumnEventArgs

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

Inheritance
System.Object
System.EventArgs
SyncfusionEventArgs
GridQueryAllowGroupByColumnEventArgs
Inherited Members
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 GridQueryAllowGroupByColumnEventArgs : SyncfusionEventArgs
Remarks

Set AllowGroupByColumn to False if you do not want to allow the user to group by the specified Column.

Constructors

GridQueryAllowGroupByColumnEventArgs(GridTableControl, GridColumnDescriptor)

Initializes the event args.

Declaration
public GridQueryAllowGroupByColumnEventArgs(GridTableControl tableControl, GridColumnDescriptor column)
Parameters
Type Name Description
GridTableControl tableControl

The table control.
GridColumnDescriptor column

Column Name.

GridQueryAllowGroupByColumnEventArgs(GridTableControl, String, String, GridQueryAllowDragColumnReason, Boolean)

Initializes the event args.

Declaration
public GridQueryAllowGroupByColumnEventArgs(GridTableControl tableControl, string column, string insertBeforeColumn, GridQueryAllowDragColumnReason reason, bool allowGroupBy)
Parameters
Type Name Description
GridTableControl tableControl

The table control.
System.String column

Column Name.
System.String insertBeforeColumn

Name of the column to insert at. You can call TableDescriptor.Columns[InsertBeforeColumn] to get the GridColumnDescriptor.
GridQueryAllowDragColumnReason reason

Reason why this event was raised (Show Red Indicator, MouseUp, or HitTest).
System.Boolean allowGroupBy

Set AllowGroupByColumn to False if you do not want to allow the user to group by the specified Column.

Properties

AllowGroupByColumn

Set AllowGroupByColumn to False if you do not want to allow the user to group by the specified Column.

Declaration
[TraceProperty(true)]
public bool AllowGroupByColumn { get; set; }
Property Value
Type
System.Boolean

Column

Column Name. You can call TableDescriptor.Columns[Column] to get the GridColumnDescriptor.

Declaration
[TraceProperty(true)]
public string Column { get; }
Property Value
Type
System.String

InsertBeforeColumn

Name of the column to insert at. You can call TableDescriptor.Columns[InsertBeforeColumn] to get the GridColumnDescriptor.

Declaration
[TraceProperty(true)]
public string InsertBeforeColumn { get; }
Property Value
Type
System.String

Reason

Reason why this event was raised (Show Red Indicator, MouseUp, or HitTest).

Declaration
[TraceProperty(true)]
public GridQueryAllowDragColumnReason Reason { get; set; }
Property Value
Type
GridQueryAllowDragColumnReason

TableControl

The table control.

Declaration
[TraceProperty(true)]
public GridTableControl TableControl { get; }
Property Value
Type
GridTableControl