Class GridGroupDropArea

Represents a control class that implements a drop area for groups control which is bound to a GridTableDescriptor. It lets the user to drag and drop column headers into its bounds and change the GroupedColumns at runtime.

Inheritance
System.Object
BaseControl
ScrollControl
GridControlBase
GridGroupDropArea
Inherited Members
Namespace: Syncfusion.Windows.Forms.Grid.Grouping
Assembly: Syncfusion.Grid.Grouping.Windows.dll
Syntax
public class GridGroupDropArea : GridControlBase, IDisposable, ICancelModeProvider, ISplitterPaneSupport, IScrollBarWrapperContainer, ISupportUpdating, ISupportIntelliMouse, IQueryFocusInside, INonClientPaintingSupport, IThemedControl, ICreateNewWindow, IGridModelSource, IGridWindowlessSite, IGridWindowlessObject, IFindParentForm, IThemeProvider, IVisualStyle

Constructors

GridGroupDropArea(GridTableControl, GridGroupDropAreaModel)

Initializes a new instance of the GridGroupDropArea class withe the specified instances of the GridTableControl and GridGroupDropAreaModel classes.

Declaration
public GridGroupDropArea(GridTableControl tableControl, GridGroupDropAreaModel model)
Parameters
Type Name Description
GridTableControl tableControl

The instances of the GridTableControl class.
GridGroupDropAreaModel model

The instances of the GridGroupDropAreaModel class.

Properties

AllowRemove

Gets or sets a value indicating whether the GridGroupDropArea should support removal of Groups dynamically.

Declaration
public bool AllowRemove { get; set; }
Property Value
Type Description
System.Boolean

DragColumnHeaderText

Gets or sets the "Drag a column header here to group by that column." text that is displayed when no columns were added to GroupDropArea.

Declaration
public string DragColumnHeaderText { get; set; }
Property Value
Type Description
System.String

DynamicResizing

Gets or sets a value indicating whether to resize the GridGroupDropArea dynamically or not. Not applicable if GridGroupingControl has multiple GridGroupDropArea.

Declaration
public bool DynamicResizing { get; set; }
Property Value
Type Description
System.Boolean

Font

Gets or sets the Font in the grid.

Declaration
public override Font Font { get; set; }
Property Value
Type Description
System.Drawing.Font

GroupingControl

Gets the instance of the GridGroupingControl that hosts this control.

Declaration
public GridGroupingControl GroupingControl { get; }
Property Value
Type Description
GridGroupingControl

HScrollBehavior

Gets or sets the Horizontal scrollbar behavior. Used internally.

Declaration
public GridScrollbarMode HScrollBehavior { get; set; }
Property Value
Type Description
GridScrollbarMode

Model

Gets or sets the model part of the Group drop area. Used internally.

Declaration
public GridGroupDropAreaModel Model { get; set; }
Property Value
Type Description
GridGroupDropAreaModel

TreeLineColor

Gets or sets the color of the TreeLines.

Declaration
public Color TreeLineColor { get; set; }
Property Value
Type Description
System.Drawing.Color

TreeLinePlacement

Gets or sets the TreeLinePlacement in the GroupDropArea.

Declaration
public TreeLinePlacement TreeLinePlacement { get; set; }
Property Value
Type Description
TreeLinePlacement

VScrollBehavior

Gets or sets the Vertical scrollbar behavior. Used internally.

Declaration
public GridScrollbarMode VScrollBehavior { get; set; }
Property Value
Type Description
GridScrollbarMode

Methods

Dispose(Boolean)

Disposes of the resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing
Overrides

GetHeaderColumnDescriptorAt(Point)

Gets the column header description at the specified point. Used internally.

Declaration
public GridColumnDescriptor GetHeaderColumnDescriptorAt(Point point)
Parameters
Type Name Description
System.Drawing.Point point

The point value specified at the column header.
Returns
Type Description
GridColumnDescriptor

The instance of the column header descriptor.

GetTreeLineBrush(out Brush, out Pen)

Overrides and draws the TreeLines. To apply color to paint the Treelines

Declaration
public void GetTreeLineBrush(out Brush brush, out Pen pen)
Parameters
Type Name Description
System.Drawing.Brush brush
System.Drawing.Pen pen

InitLayout()

Initialize the layout.

Declaration
protected override void InitLayout()
Overrides

Invalidate()

Overrides an refreshes the model. Used internally.

Declaration
public override void Invalidate()
Overrides

OnBackColorChanged(EventArgs)

Overrides and triggered when the back color of the group drop area had changed.

Declaration
protected override void OnBackColorChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

The System.EventArgs contains the event data.

OnBeforePaint(EventArgs)

Overrides and triggered before painting is done.

Declaration
protected override void OnBeforePaint(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

The System.EventArgs contains the event data.
Overrides

OnCellClick(GridCellClickEventArgs)

Overrides and triggered when the grid cell is clicked.

Declaration
protected override void OnCellClick(GridCellClickEventArgs e)
Parameters
Type Name Description
GridCellClickEventArgs e

The GridCellClickEventArgs contains the event data.
Overrides

OnCellDrawn(GridDrawCellEventArgs)

Handler to draw the TreeLines

Declaration
protected override void OnCellDrawn(GridDrawCellEventArgs e)
Parameters
Type Name Description
GridDrawCellEventArgs e

The GridDrawCellEventArgs contains the event data.
Overrides

OnForeColorChanged(EventArgs)

Overrides and triggered when the fore color of the group drop area had changed.

Declaration
protected override void OnForeColorChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

The System.EventArgs contains the event data.

OnMouseDown(MouseEventArgs)

Overrides and triggered when the mouse down event is done.

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs contains the event data.
Overrides

OnMouseEnter(EventArgs)

Overrides and triggered when the mouse enter event is done.

Declaration
protected override void OnMouseEnter(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

The System.Windows.Forms.MouseEventArgs contains the event data.

OnMouseMove(MouseEventArgs)

Overrides and triggered when the mouse move event is done.

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs contains the event data.
Overrides

OnPaint(PaintEventArgs)

Overrides and triggered when the paint event is done.

Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.PaintEventArgs e

The System.Windows.Forms.PaintEventArgs contains the event data.
Overrides

OnParentForeColorChanged(EventArgs)

Overrides and triggered when the parent control's fore color is changed.

Declaration
protected override void OnParentForeColorChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

The System.EventArgs contains the event data.

OnTouchPan(Point, Boolean)

Handles the Resize,Selection,Dragging or the panning operations based on the touch controller.

Declaration
protected override bool OnTouchPan(Point currentTouchPoint, bool isSwipeScroll)
Parameters
Type Name Description
System.Drawing.Point currentTouchPoint

Current touch position
System.Boolean isSwipeScroll

used to decide the swipe scrolling operation occurs
Returns
Type Description
System.Boolean

Returns false if do the resize, dragging and selection process otherwise return true
Overrides

OnTouchPanBegin(Point)

Used to decide to do the selection or dragging or resizing operations based on touchController.

Declaration
protected override bool OnTouchPanBegin(Point touchBeginPoint)
Parameters
Type Name Description
System.Drawing.Point touchBeginPoint

touch position when panning operation start
Returns
Type Description
System.Boolean

return false when do other operations like selection, dragging and resizing
Overrides

OnTouchPanEnd(Point)

Initialize the mouse up method when resize or dragging or selection process done, otherwise call the base method

Declaration
protected override bool OnTouchPanEnd(Point touchEndPoint)
Parameters
Type Name Description
System.Drawing.Point touchEndPoint

touch control end point
Returns
Type Description
System.Boolean

Return false when resizing or selection or dragging process done
Overrides

Refresh(Boolean)

Overrides and refreshes the grid.

Declaration
protected override void Refresh(bool fromModel)
Parameters
Type Name Description
System.Boolean fromModel

If True, then refresh is done from the parent; Otherwise False.
Overrides

UnwireModel()

Unwires the model from the parent.

Declaration
protected override void UnwireModel()
Overrides

WireModel()

Wires the model to the parent.

Declaration
protected override void WireModel()
Overrides

WndProc(ref Message)

Processes Windows messages and optionally routes them to the control.

Declaration
protected override void WndProc(ref Message msg)
Parameters
Type Name Description
System.Windows.Forms.Message msg

The System.Windows.Forms.Message contains the event data.
Overrides

Implements

System.IDisposable