Class GridMaskEditCellRenderer
Implements the renderer part of a currency cell.
Inheritance
Inherited Members
Namespace: Syncfusion.Windows.Forms.Grid
Assembly: Syncfusion.Grid.Windows.dll
Syntax
public class GridMaskEditCellRenderer : GridStaticCellRenderer, IQueryFocusInside, IGridDropDownCell, IPopupParent, IPopupItem, IDisposableRemarks
Use the MaskEdit (GridMaskEditInfo) property of a GridStyleInfo to change masked edit properties for a cell.
The following table lists some characteristics about the MaskedEdit cell type:
| Item | Description |
|---|---|
| CellType | MaskEdit |
| Renderer | GridMaskEditCellRenderer |
| Model | GridMaskEditCellModel |
| XP Themes Support | NA |
| Interactive | Edit with Text Input |
| Control | GridMaskedEditBox |
| Floating Support | Both |
| Base Type | GridStaticCellRenderer |
The cell's behavior and appearance can be customized with the following properties of the GridStyleInfo class:
| PropertyName | Description |
|---|---|
| AutoSize (System.Boolean) | Gets / sets if the cell height should automatically increase when the edited text does not fit into the cell and WrapText is True. If WrapText is False, AutoSize will affect the column width. (Default: False) |
| 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) |
| Borders (GridBordersInfo) | Top, left, bottom, and right border settings. (Default: GridBordersInfo.Default) |
| CellAppearance (GridCellAppearance) | Specifies if cell edges shall be drawn raised, sunken, or flat (default). (Default: GridCellAppearance.Flat) |
| CellTipText (System.String) | ToolTip text to be displayed when user hovers mouse over cell. (Default: String.Empty) |
| CellType (System.String) | MaskedEdit (Default: Text Box) |
| 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) |
| 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, Error will contain error information. (Default: NULL) |
| CultureInfo (System.Globalization.CultureInfo) | The culture information holds rules for parsing and formatting the cell's value. (Default: NULL) |
| Enabled (System.Boolean) | Specifies if the cell can be activated as current cell or if the cell should be skipped when moving the current cell. (Default: True) |
| Error (System.String) | Holds error information if a value could not be converted to the System.Type specified with CellValueType. (Default: String.Empty) |
| FloatCell (System.Boolean) | Gets / sets if text can float into the boundaries of a neighboring cell. (Default: True) |
| FloodCell (System.Boolean) | Gets / sets if this cell can be flooded by a previous cell. (Default: True) |
| Font (GridFontInfo) | The font for drawing text. (Default: GridFontInfo.Default) |
| 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 Specifies and Format Providers" of the .NET Framework Developers Guide (see ms-help://MS.VSCC/MS.MSDNVS/cpguide/html/cpconformatspecifiersformatproviders.htm) (Default: String.Empty) |
| Interior (BrushInfo) | Lets you specify a solid backColor, gradient, or pattern style with both back and foreColor for a cell's background. (Default: SystemColors.Window) |
| MaskEdit (GridMaskEditInfo) | A nested object with masked edit properties for a cell. (Default: GridMaskEditInfo.Default) |
| 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) |
| MergeCell (GridMergeCellDirection) | Specifies merge behavior for an individual cell when merging cell's features have been enabled in a GridModel with MergeCellsMode. (Default: GridMergeCellDirection.None) |
| ReadOnly (System.Boolean) | Specifies if cell contents can be modified by the user. You can programmatically change Read-only cells by setting DiscardReadOnly to True. (Default: False) |
| Text (System.String) | Gets / sets the value as a string. If a CellValueType is specified, the text will be parsed and converted to the type specified with CellValueType using any CultureInfo information. (Default: String.Empty) |
| TextColor (System.Drawing.Color) | Lets you specify the color for drawing the cell text. (Default: SystemColors.WindowText) |
| TextMargins (GridMarginsInfo) | Holds text margins in pixels. When drawing a cell, this specifies the empty area between the text rectangle and the client rectangle of the cell without borders and cell buttons. (Default: GridMarginsInfo.Default) |
Constructors
GridMaskEditCellRenderer(GridControlBase, GridCellModelBase)
Initializes a new GridMaskEditCellRenderer object for the given GridControlBase and GridCellModelBase.
Declaration
public GridMaskEditCellRenderer(GridControlBase grid, GridCellModelBase cellModel)Parameters
| Type | Name | Description |
|---|---|---|
| GridControlBase | grid | The GridControlBase that displays this cell renderer. |
| GridCellModelBase | cellModel | The GridCellModelBase that holds data for this cell renderer that should be shared among views. |
Remarks
References to GridControlBase and GridCellModelBase will be saved.
Methods
CanCopy()
Determines whether the current cell can be copied to clipboard.
Declaration
public override bool CanCopy()Returns
| Type | Description |
|---|---|
| System.Boolean | True if it can be copied; False otherwise. |
Overrides
InitializeControlText(Object)
Initializes ControlText based on the specified cell value.
Declaration
protected override void InitializeControlText(object controlValue)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | controlValue | The cell value. See the CellValue of the GridStyleInfo class. |
Overrides
Remarks
The default behavior of this method is to call GetFormattedText(Object) event.
The user can catch the event and change the ControlText property of the GridCurrentCellInitializeControlTextEventArgs object.
OnActivated()
This is called after the activating event and notifies that at this time the current cell has now become the active current cell.
Declaration
protected override void OnActivated()Overrides
OnClick(Int32, Int32, MouseEventArgs)
This is called from GridSelectCellsMouseController when the user clicked inside a cell.
Declaration
protected override void OnClick(int rowIndex, int colIndex, MouseEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | The row index. |
| System.Int32 | colIndex | The column index. |
| System.Windows.Forms.MouseEventArgs | e | The System.Windows.Forms.MouseEventArgsthat contains event data. |
Overrides
OnDoubleClick(Int32, Int32, MouseEventArgs)
This is called from GridSelectCellsMouseController when the user double-clicks inside a cell.
Declaration
protected override void OnDoubleClick(int rowIndex, int colIndex, MouseEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | The row index. |
| System.Int32 | colIndex | The column index. |
| System.Windows.Forms.MouseEventArgs | e | The System.Windows.Forms.MouseEventArgsthat contains event data. |
Overrides
OnDraw(Graphics, Rectangle, Int32, Int32, GridStyleInfo)
Declaration
protected override void OnDraw(Graphics g, Rectangle clientRectangle, int rowIndex, int colIndex, GridStyleInfo style)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Graphics | g | |
| System.Drawing.Rectangle | clientRectangle | |
| System.Int32 | rowIndex | |
| System.Int32 | colIndex | |
| GridStyleInfo | style |
Overrides
OnHasFocusControlChanged()
Override this method if your cell renderer supports in-place editing and you want to do any custom initialization at this point before cell gets redrawn.
Declaration
protected override void OnHasFocusControlChanged()Overrides
Remarks
The default behavior of this virtual method is to force a redraw of the current cell. A cell can then initialize an edit control and set focus in the OnDraw method call.
OnInitialize(Int32, Int32)
This method gets called from the cell renderer's initialize method. Override this method if you need to any initialization for the current cell.
Declaration
protected override void OnInitialize(int rowIndex, int colIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | The row index. |
| System.Int32 | colIndex | The column index. |
Overrides
OnKeyDown(KeyEventArgs)
User pressed key down (similar to Control.OnKeyDown).
Declaration
protected override void OnKeyDown(KeyEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.KeyEventArgs | e | The System.Windows.Forms.KeyEventArgsthat contains event data |
Overrides
OnKeyPress(KeyPressEventArgs)
User pressed key (similar to Control.OnKeyPress).
Declaration
protected override void OnKeyPress(KeyPressEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.KeyPressEventArgs | e | The System.Windows.Forms.KeyEventArgsthat contains event data. |
Overrides
OnLayout(Int32, Int32, GridStyleInfo, Rectangle, Rectangle[])
This method is called from PerformLayout to calculate the client rectangle given the inner rectangle of a cell and any boundaries of cell buttons.
Declaration
protected override Rectangle OnLayout(int rowIndex, int colIndex, GridStyleInfo style, Rectangle innerBounds, Rectangle[] buttonsBounds)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | The row index. |
| System.Int32 | colIndex | The column index. |
| GridStyleInfo | style | The GridStyleInfo object that holds cell information. |
| System.Drawing.Rectangle | innerBounds | The System.Drawing.Rectangle with the inner bounds of a cell. |
| System.Drawing.Rectangle[] | buttonsBounds | An array of System.Drawing.Rectangle with bounds for each cell button element. |
Returns
| Type | Description |
|---|---|
| System.Drawing.Rectangle | A System.Drawing.Rectangle with the bounds. |
Overrides
OnValidate()
This method is called from GridCurrentCell.Validate after GridCurrentCell.Validating event has been fired. The default version checks if the active text fits any criteria as specified in the style object: It can be parsed into a cell value and meets GridCellValidateValueInfo criteria.
Declaration
protected override bool OnValidate()Returns
| Type | Description |
|---|---|
| System.Boolean | True if the modified text is valid; False otherwise. |