Class GridCellUpDownButton

Defines the up / down cell button elements of a GridNumericUpDownCellRenderer.

Inheritance
System.Object
NonFinalizeDisposable
GridCellButton
GridCellUpDownButton
EnhancedUpDownButton
Implements
System.IDisposable
Inherited Members
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)
System.Object.ToString()
Namespace: Syncfusion.Windows.Forms.Grid
Assembly: Syncfusion.Grid.Windows.dll
Syntax
public class GridCellUpDownButton : GridCellButton, IDisposable
Remarks

The up-down buttons are XP Themes enabled. They will be drawn with a theme if ThemesEnabled is True.

The button supports auto-clicking. When the user holds the mouse on a button, the button will continuously raise Clicked events.

Constructors

GridCellUpDownButton(GridCellRendererBase, ScrollButton)

Initializes a new GridCellUpDownButton and associates it with a GridCellRendererBase and saves the System.Windows.Forms.ScrollButton type.

Declaration
public GridCellUpDownButton(GridCellRendererBase control, ScrollButton button)
Parameters
Type Name Description
GridCellRendererBase control

The GridCellRendererBase that manages the GridCellButton.
System.Windows.Forms.ScrollButton button

The System.Windows.Forms.ScrollButton type of this button. Up or down.

Properties

ButtonType

Gets the System.Windows.Forms.ScrollButton of this current button: Up or down.

Declaration
public ScrollButton ButtonType { get; }
Property Value
Type
System.Windows.Forms.ScrollButton

Methods

CancelMode(GridCellHitTestInfo)

Occurs when the current mouse operation is canceled.

Declaration
public override void CancelMode(GridCellHitTestInfo ht)
Parameters
Type Name Description
GridCellHitTestInfo ht

The GridCellHitTestInfo with saved hit-test information about the mouse event.
Overrides

Dispose(Boolean)

Used to dispose the GridCellUpDownButton

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

Boolean to control disposing.
Overrides

DrawButton(Graphics, Rectangle, ButtonState, GridStyleInfo)

Draws a button using System.Windows.Forms.ControlPaint.DrawButton(System.Drawing.Graphics,System.Drawing.Rectangle,System.Windows.Forms.ButtonState) or if XP Themes are enabled, button will be drawn themed.

Declaration
public override void DrawButton(Graphics g, Rectangle rect, ButtonState buttonState, GridStyleInfo style)
Parameters
Type Name Description
System.Drawing.Graphics g

The System.Drawing.Graphics context of the canvas.
System.Drawing.Rectangle rect

The System.Drawing.Rectangle with the bounds.
System.Windows.Forms.ButtonState buttonState

A System.Windows.Forms.ButtonState that specifies the current state.
GridStyleInfo style

The style information for the cell.
Overrides

MouseDown(MouseEventArgs, GridCellHitTestInfo)

This is called from GridCellRendererBase when HitTest(Int32, Int32, MouseEventArgs, IMouseController) has indicated it wants to receive mouse events and the user has pressed the mouse button.

Declaration
public override void MouseDown(MouseEventArgs e, GridCellHitTestInfo ht)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs with data about the mouse event.
GridCellHitTestInfo ht

The GridCellHitTestInfo with saved hit-test information about the mouse event.
Overrides

MouseMove(MouseEventArgs, GridCellHitTestInfo)

This is called from GridCellRendererBase when HitTest(Int32, Int32, MouseEventArgs, IMouseController) has indicated it wants to receive mouse events and the user has pressed the mouse button and is moving the mouse.

Declaration
public override void MouseMove(MouseEventArgs e, GridCellHitTestInfo ht)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs with data about the mouse event.
GridCellHitTestInfo ht

The GridCellHitTestInfo with saved hit-test information about the mouse event.
Overrides

MouseUp(MouseEventArgs, GridCellHitTestInfo)

This is called from GridCellRendererBase when HitTest(Int32, Int32, MouseEventArgs, IMouseController) has indicated it wants to receive mouse events and the user has released the mouse button.

Declaration
public override void MouseUp(MouseEventArgs e, GridCellHitTestInfo ht)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs with data about the mouse event.
GridCellHitTestInfo ht

The GridCellHitTestInfo with saved hit-test information about the mouse event.
Overrides

Implements

System.IDisposable