Syncfusion.Windows.Forms.Grid Namespace : GridNumericUpDownCellRenderer Class

GridNumericUpDownCellRenderer Class

Defines the renderer part of a numeric up / down cell that lets users increase and decrease values with spin buttons.
Object Model
GridNumericUpDownCellRenderer ClassGridCurrentCell ClassGridStyleInfo ClassGridCellButton ClassIGridDropDownContainer InterfaceIGridDropDownCellImp InterfaceIGridDropDownCellImp InterfaceGridControlBase ClassGridCellModelBase ClassGridStyleInfo Class
A GridNumericUpDownCellRenderer cell's behavior can be customized with the GridStyleInfo.NumericUpDown property of a GridStyleInfo instance and any properties that affect regular text boxes as specified for GridTextBoxCellRenderer and GridStaticCellRenderer.

GridStyleInfo.NumericUpDown lets you specify the step, minimum and maximum value, and if the value should start over when you reach the maximum value.

GridNumericUpDownCellRenderer displays two GridCellUpDownButton cell button elements at the right side of the cell. You can specify when these buttons are shown with the GridStyleInfo.ShowButtons property of a GridStyleInfo instance.

You can disable these buttons when you reset the GridStyleInfo.Clickable property of GridStyleInfo to False.

A renderer is created for each GridCellModelBase and GridControlBase. There can be several renderers associated with one GridNumericUpDownCellModel if several views display the same GridModel.

The up-down buttons are XP Themes enabled. They will be drawn themed if GridControlBase.ThemesEnabled is true.

The following table lists some characteristics about the NumericUpDown cell type:

Item Description
CellType NumericUpDown
Renderer GridNumericUpDownCellRenderer
Model GridNumericUpDownCellModel
XP Themes Support Yes
Cell Button GridCellUpDownButton
Interactive Edit with Text Input or click on Up-/Down Buttons
Control GridTextBoxControl
Floating Support No
Base Type GridTextBoxCellRenderer

The cells behavior and appearance can be customized with the following properties of the GridStyleInfo class:

PropertyName Description
GridStyleInfo.AllowEnter (System.Boolean) Gets / sets if pressing the <Enter>-Key should insert a new line into the edited text. (Default: False)
GridStyleInfo.AutoSize (System.Boolean) Gets / sets if the cell height should automatically increase when the edited text does not fit into the cell and GridStyleInfo.WrapText is True. If GridStyleInfo.WrapText is False, GridStyleInfo.AutoSize will affect the column width. (Default: False)
GridStyleInfo.BaseStyle (System.String) The base style for this style instance with default values for properties that are not initialized for this style object. (Default: String.Empty)
GridStyleInfo.Borders (GridBordersInfo) Top, left, bottom, and right border settings. (Default: GridBordersInfo.Default)
GridStyleInfo.CellAppearance (GridCellAppearance) Specifies if cell edges shall be drawn raised, sunken, or flat (default). (Default: GridCellAppearance.Flat)
GridStyleInfo.CellTipText (System.String) ToolTip text to be displayed when user hovers mouse over cell. (Default: String.Empty)
GridStyleInfo.CellType (System.String) NumericUpDown (Default: Text Box)
GridStyleInfo.CellValue (System.Object) This property holds the cell value. Although the cell value is typically a string, it can also be any other primitive type such as int, byte, enum, or any custom type that is derived from System.Object. (Default: String.Empty)
GridStyleInfo.CellValueType (System.Type) Specifies the preferred System.Type for cell values. When you assign a value to the GridStyleInfo object, the value will be converted to this type. If the value cannot be converted, GridStyleInfo.Error will contain error information. (Default: NULL)
GridStyleInfo.Clickable (System.Boolean) Specifies if up / down buttons can be clicked. If set to False, the buttons will be drawn grayed out. See GridStyleInfo.Enabled to disable activating the cell as current cell. (Default: True)
GridStyleInfo.CultureInfo (System.Globalization.CultureInfo) The culture information holds rules for parsing and formatting the cells value. (Default: NULL)
GridStyleInfo.Enabled (System.Boolean) Specifies if the cell can be activated as current cell or if cell should be skipped when moving the current cell. When disabled, the up / down buttons will be drawn grayed out. (Default: True)
GridStyleInfo.Error (System.String) Holds error information if a value could not be converted to the System.Type specified with GridStyleInfo.CellValueType. (Default: String.Empty)
GridStyleInfo.Font (GridFontInfo) The font for drawing text. (Default: GridFontInfo.Default)
GridStyleInfo.Format (System.String) Gets / sets the format mask for formatting the cell value. You can specify numeric format strings, date format strings, or enumeration format strings as discussed in the section "Format Specifiers and Format Providers" of the .NET Framework Developers Guide (see ms-help://MS.VSCC/MS.MSDNVS/cpguide/html/cpconformatspecifiersformatproviders.htm) (Default: String.Empty)
GridStyleInfo.HorizontalAlignment (GridHorizontalAlignment) Specifies the horizontal alignment of text in the cell. This does not affect the position of the up / down buttons. (Default: GridHorizontalAlignment.Left)
GridStyleInfo.HotkeyPrefix (System.Drawing.Text.HotkeyPrefix) Specifies how hot-key prefixes should be displayed. Hot-keys are indicated in text with an '&' (ampersand). When you enable the hot-key prefix, the specific characters can be displayed underlined or regular. The '&' will not be displayed. (Default: HotkeyPrefix.Show)
GridStyleInfo.ImageIndex (System.Int32) Specifies an index for an image in the GridStyleInfo.ImageList of a GridStyleInfo instance. (Default: -1)
GridStyleInfo.ImageList (System.Windows.Forms.ImageList) The GridStyleInfo.ImageList that holds a collection of images. Cells can choose images with the GridStyleInfo.ImageIndex property in a GridStyleInfo instance. (Default: NULL)
GridStyleInfo.Interior (Syncfusion.Drawing.BrushInfo) Lets you specify a solid backColor, gradient, or pattern style with both back and foreColor for a cell's background. (Default: SystemColors.Window)
GridStyleInfo.MaxLength (System.Int32) Limits the number of characters the user can type into the cell. Note: When selecting a text from a choice list or when pasting text, the text can be longer. Additional validation is necessary on your side. (Default: 0)
GridStyleInfo.NumericUpDown (GridNumericUpDownCellInfo) GridStyleInfo.NumericUpDown lets you specify the step, minimum and maximum value, and if the value should start over when you reach the maximum value. (Default: NULL)
GridStyleInfo.ReadOnly (System.Boolean) Specifies if cell contents can be modified by the user. You can programmatically change Read-only cells by setting GridModel.DiscardReadOnly to True. (Default: False)
GridStyleInfo.ShowButtons (GridShowButtons) Specifies when to show or display the drop-down button. Possible choices are: show the button only for the current cell, always show buttons, or never show buttons. (Default: GridShowButtons.Show)
GridStyleInfo.Text (System.String) Gets / sets the value as a string. If a GridStyleInfo.CellValueType is specified, the text will be parsed and converted to the type specified with GridStyleInfo.CellValueType using any GridStyleInfo.CultureInfo information. (Default: String.Empty)
GridStyleInfo.TextAlign (GridTextAlign) Align text left of button elements (which is typical for NumericUpDown). Or align text right of button elements. (Default: GridTextAlign.Default)
GridStyleInfo.TextColor (System.Drawing.Color) Lets you specify the color for drawing the cell text. (Default: SystemColors.WindowText)
GridStyleInfo.TextMargins (GridMarginsInfo) Holds text margins in pixels. When drawing a cell, this specifies the empty area between the text rectangle and the borders of the client rectangle of the cell. The client rectangle is the cell rectangle without buttons and borders. (Default: GridMarginsInfo.Default)
GridStyleInfo.Themed (System.Boolean) Specifies if cell should be drawn using Windows XP themes when GridControlBase.ThemesEnabled has been set. (Default: True)
GridStyleInfo.Trimming (System.Drawing.StringTrimming) Indicates how text is trimmed when it exceeds the edges of the cell text rectangle. (Default: StringTrimming.Character)
GridStyleInfo.ValidateValue (GridCellValidateValueInfo) Holds validation rules for the cell values that are being checked before any user changes are committed to the grid cells style object. (Default: null)
GridStyleInfo.VerticalAlignment (GridVerticalAlignment) Specifies vertical alignment of text and the up / down buttons in the cell. (Default: GridVerticalAlignment.Top)
GridStyleInfo.WrapText (System.Boolean) Specifies if text should be wrapped when it does not fit into a single line. (Default: True)

Inheritance Hierarchy



Syncfusion.Grid.Windows: 18.1460.0.42

See Also