Class GroupPanel

Represents the panel for drawing the GroupDropItem.

Inheritance
System.Object
BaseControl
SfScrollControl
GroupPanel
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.WinForms.DataGrid
Assembly: Syncfusion.SfDataGrid.WinForms.dll
Syntax
public class GroupPanel : SfScrollControl, IThemeProvider, IVisualStyle, IDisposable, ISupportUpdate

Constructors

GroupPanel(SfDataGrid)

Initializes a new instance of the GroupPanel class.

Declaration
public GroupPanel(SfDataGrid dataGrid)
Parameters
Type Name Description
SfDataGrid dataGrid

The SfDataGrid that needs to show the GroupPanel.

Properties

GroupDropAreaText

Gets or sets the string that is used to displayed on the GroupDropArea in SFDataGrid.

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

The string that is used to displayed on the GroupDropArea.

RightToLeft

Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.

Declaration
public override RightToLeft RightToLeft { get; set; }
Property Value
Type
System.Windows.Forms.RightToLeft

Methods

Dispose(Boolean)

Disposes of the resource used by the GroupPanel.

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

Indicates the call is from Dispose method.
Overrides

OnHorizontalScroll(ScrollEventArgs)

Overridden to update the scroll values of the HorizontalScrollBar while scrolling.

Declaration
protected override void OnHorizontalScroll(ScrollEventArgs se)
Parameters
Type Name Description
System.Windows.Forms.ScrollEventArgs se

The System.Windows.Forms.ScrollEventArgs that contains event data.
Overrides

OnMarginChanged(EventArgs)

Occur when margin value is changed.

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

The System.EventArgs that contains the event data.

OnMouseClick(MouseEventArgs)

Overridden to handle the mouse click on the group drop items.

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

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

OnMouseDown(MouseEventArgs)

Overridden to handle the dragging of the group drop items.

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

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

OnMouseMove(MouseEventArgs)

Overridden to handle the mouse moves on the GroupPanel.

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

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

OnMouseUp(MouseEventArgs)

Overridden to handle the moving and adding of the GroupPanel items using the drag and drop.

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

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

OnPaint(PaintEventArgs)

Overridden to draw the GroupPanel customization.

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

The System.Windows.Forms.PaintEventArgs that contains event data.

OnSizeChanged(EventArgs)

Overridden to update the group drop panel when the Size is changed.

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

The System.EventArgs that contains the event data.
Overrides

OnTouchPan(Point, Boolean)

Overridden to update the old scroll values on panning.

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

The current touch position.
System.Boolean isSwipeScroll

Indicates whether to perform swipe or pan operation.
Returns
Type Description
System.Boolean

Returns false when the panning is started over the frozen rows, otherwise returns true.
Overrides

OnTouchPanBegin(Point)

Overridden to check whether the touch start position begins with the Frozen rows or not.

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

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

Return false when the start positions is contains the frozen rows, otherwise return true.
Overrides

OnTouchPanEnd(Point)

Overridden to raise the MouseUp event when the dragging is performed on the frozen rows.

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

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

Return false when the start positions is contains the frozen rows, otherwise return true.
Overrides

ShouldSerializeGroupDropAreaText()

Determines whether GroupDropAreaText has been modified and its contents should be serialized at design-time.

Declaration
public bool ShouldSerializeGroupDropAreaText()
Returns
Type Description
System.Boolean

True if contents were changed; False otherwise.

UpdateScrollBars()

Updates the Scrollbars when performs the row or column manipulation(Insert, delete, hide, adjust size, etc.).

Declaration
public override void UpdateScrollBars()
Overrides

WndProc(ref Message)

Processes Windows messages.

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

The Windows System.Windows.Forms.Message to process.
Overrides

Implements

System.IDisposable