Class GridQueryAllowDragColumnEventArgs

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

Inheritance

System.Object

System.EventArgs

SyncfusionEventArgs

SyncfusionHandledEventArgs

GridQueryAllowDragColumnEventArgs

Inherited Members

SyncfusionEventArgs.ToString()

SyncfusionHandledEventArgs.Handled

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 GridQueryAllowDragColumnEventArgs : SyncfusionHandledEventArgs

Remarks

Set AllowDrag to False if you do not want to allow the user to drag the specified Column.

Constructors

GridQueryAllowDragColumnEventArgs(GridTableControl, GridColumnDescriptor, GridQueryAllowDragColumnReason, MouseEventArgs)

Initializes the event args.

Declaration

public GridQueryAllowDragColumnEventArgs(GridTableControl tableControl, GridColumnDescriptor column, GridQueryAllowDragColumnReason reason, MouseEventArgs mouseEventArgs)

Parameters

Type	Name	Description
GridTableControl	tableControl	The table control.
GridColumnDescriptor	column	Column Name.
GridQueryAllowDragColumnReason	reason	The reason why this event is raised.
System.Windows.Forms.MouseEventArgs	mouseEventArgs	A System.Windows.Forms.MouseEventArgs contains the event data.

GridQueryAllowDragColumnEventArgs(GridTableControl, GridColumnDescriptor, GridStackedHeaderDescriptor, GridQueryAllowDragColumnReason, MouseEventArgs)

Initializes the event args.

Declaration

public GridQueryAllowDragColumnEventArgs(GridTableControl tableControl, GridColumnDescriptor column, GridStackedHeaderDescriptor stackHeader, GridQueryAllowDragColumnReason reason, MouseEventArgs mouseEventArgs)

Parameters

Type	Name	Description
GridTableControl	tableControl	The table control.
GridColumnDescriptor	column	Column Name.
GridStackedHeaderDescriptor	stackHeader	The stackedheaderdescriptor.
GridQueryAllowDragColumnReason	reason	The reason why this event is raised.
System.Windows.Forms.MouseEventArgs	mouseEventArgs	A System.Windows.Forms.MouseEventArgs contains the event data.

GridQueryAllowDragColumnEventArgs(GridTableControl, String, String, GridQueryAllowDragColumnReason)

Initializes the event args.

Declaration

public GridQueryAllowDragColumnEventArgs(GridTableControl tableControl, string column, string insertBeforeColumn, GridQueryAllowDragColumnReason reason)

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).

GridQueryAllowDragColumnEventArgs(GridTableControl, String, String, String, GridQueryAllowDragColumnReason)

Initializes the event args.

Declaration

public GridQueryAllowDragColumnEventArgs(GridTableControl tableControl, string column, string stackHeader, string insertBeforeColumn, GridQueryAllowDragColumnReason reason)

Parameters

Type	Name	Description
GridTableControl	tableControl	The table control.
System.String	column	Column Name.
System.String	stackHeader	StackedHeader 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).

Properties

AllowDrag

Set AllowDrag to False if you do not want to allow the user to drag the specified Column.

Declaration

[TraceProperty(true)]
public bool AllowDrag { 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

MouseEventArgs

The MouseEventArgs for HitTest. Will be null if Reason is not HitTest.

Declaration

[TraceProperty(false)]
public MouseEventArgs MouseEventArgs { get; }

Property Value

Type
System.Windows.Forms.MouseEventArgs

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

StackedHeader

Stacked Header Name.

Declaration

[TraceProperty(true)]
public string StackedHeader { get; }

Property Value

Type
System.String

TableControl

The table control.

Declaration

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

Property Value

Type
GridTableControl