Class GridOriginalTextBoxCellRenderer
Implements the renderer part of a text box cell.
Inheritance
System.Object
GridOriginalTextBoxCellRenderer
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.Windows.Forms.Grid
Assembly: Syncfusion.Grid.Windows.dll
Syntax
public class GridOriginalTextBoxCellRenderer : GridTextBoxCellRenderer, IQueryFocusInside, IGridDropDownCell, IPopupParent, IPopupItem, IDisposableRemarks
Use "OriginalTextBox" as identifier in CellType of a cells GridStyleInfo to associate this cell type with a cell.
The "OriginalTextBox" cell type supports password entry and upper/lower case data entry. See the PasswordChar and CharacterCasing properties of the GridStyleInfo class.
The following table lists some characteristics about the OriginalTextBox cell type:
| Item | Description |
|---|---|
| CellType | OriginalTextBox |
| Renderer | GridOriginalTextBoxCellRenderer |
| Model | GridOriginalTextBoxCellModel |
| XP Themes Support | NA |
| Interactive | Edit with Text Input |
| Control | System.Windows.Forms.TextBox |
| 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 |
|---|---|
| AllowEnter (System.Boolean) | Gets / sets if pressing the <Enter>-Key should insert a new line into the edited text. (Default: False) |
| 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) |
| BackgroundImage (System.Drawing.Image) | Gets / sets the image that the cells display as background. (Default: NULL) |
| BackgroundImageMode (GridBackgroundImageMode) | Indicates how the background image is displayed. (Default: GridBackgroundImageMode) |
| 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) | OriginalTextBox (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) |
| CharacterCasing (System.Windows.Forms.CharacterCasing) | Specifies if cell control modifies the case of characters as they are typed when the cell's CellType is "OriginalTextBox". (Default: CharacterCasing.Normal) |
| 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 Specifiers and Format Providers" of the .NET Framework Developers Guide (see ms-help://MS.VSCC/MS.MSDNVS/cpguide/html/cpconformatspecifiersformatproviders.htm) (Default: String.Empty) |
| HorizontalAlignment (GridHorizontalAlignment) | Specifies horizontal alignment of text in the cell. (Default: GridHorizontalAlignment.Left) |
| 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 hot-key prefix, the specific characters can be displayed underlined or regular. The '&' will not be displayed. (Default: HotkeyPrefix.Show) |
| ImageIndex (System.Int32) | Specifies an index for an image in the ImageList of a GridStyleInfo instance. (Default: -1) |
| ImageList (System.Windows.Forms.ImageList) | The ImageList that holds a collection of images. Cells can choose images with the ImageIndex property in a GridStyleInfo instance. (Default: NULL) |
| 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) |
| 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 cells features have been enabled in a GridModel with MergeCellsMode. (Default: GridMergeCellDirection.None) |
| PasswordChar (System.Char) | The character used to mask characters of a password in a password-entry cell. The cells CellType must be "OriginalTextBox". (Default: Blank) |
| ReadOnly (System.Boolean) | Specifies if cell contents can be modified by the user. You can programatically change Read-only cells by setting DiscardReadOnly to True. (Default: False) |
| StrictValueType (System.Boolean) | Indicates whether an exception should be thrown in the ApplyFormattedText(String) method if the formatted text can not be parsed and converted to the type specified with CellValueType. (Default: True) |
| 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) |
| Trimming (System.Drawing.StringTrimming) | Indicates how text is trimmed when it exceeds the edges of the cell text rectangle. (Default: StringTrimming.Character) |
| ValidateValue (GridCellValidateValueInfo) | Holds validation rules for the cell values that are being checked before any user changes are committed to the grid cell's style object. (Default: NULL) |
| VerticalAlignment (GridVerticalAlignment) | Specifies vertical alignment of text in the cell. (Default: GridVerticalAlignment.Top) |
| VerticalScrollbar (System.Boolean) | Specifies if the text box should show a vertical scrollbar when text is being edited and does not fit in cell. WrapText must be initialized to True. (Default: False) |
| WrapText (System.Boolean) | Specifies if text should be wrapped when it does not fit into a single line. (Default: True) |
Examples
The following code samples show how to apply PasswordChar and CharacterCasing
form.Text = "Password Cells";
gridControl1.BeginUpdate();
gridControl1.TableStyle.FloatCell = true;
gridControl1.FloatCellsMode = GridFloatCellsMode.OnDemandCalculation;
gridControl1.TableStyle.BackColor = Color.FromArgb(204, 212, 230);
gridControl1.TableStyle.CellType = "OriginalTextBox";
GridStyleInfo style;
for (int row = 2; row != 10; row++)
{
style = gridControl1[row, 2];
style.PasswordChar = '*';
style.Text = new string((char) (65 + row), row);
style = gridControl1[row, 3];
style.CharacterCasing = CharacterCasing.Lower;
style.Text = new string((char) (65 + row), row);
style = gridControl1[row, 4];
style.CharacterCasing = CharacterCasing.Upper;
style.Text = new string((char) (65 + row), row);
}
gridControl1.EndUpdate(true);form.Text = "Password Cells"
gridControl1.BeginUpdate()
gridControl1.TableStyle.FloatCell = True
gridControl1.FloatCellsMode = GridFloatCellsMode.OnDemandCalculation
gridControl1.TableStyle.BackColor = Color.FromArgb(204, 212, 230)
gridControl1.TableStyle.CellType = "OriginalTextBox"
Dim style As GridStyleInfo
Dim row As Integer
For row = 2 To 10
style = gridControl1(row, 2)
style.PasswordChar = "*"c
style.Text = New String(ChrW(65 + row), row)
style = gridControl1(row, 3)
style.CharacterCasing = CharacterCasing.Lower
style.Text = New String(ChrW(65 + row), row)
style = gridControl1(row, 4)
style.CharacterCasing = CharacterCasing.Upper
style.Text = New String(ChrW(65 + row), row)
Next row
gridControl1.EndUpdate(True)Constructors
GridOriginalTextBoxCellRenderer(GridControlBase, GridCellModelBase)
Initializes a new GridOriginalTextBoxCellRenderer object for the given GridControlBase and GridCellModelBase.
Declaration
public GridOriginalTextBoxCellRenderer(GridControlBase grid, GridCellModelBase cellModel)Parameters
| Type | Name | Description |
|---|---|---|
| GridControlBase | grid | The GridControlBase that display 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.
Properties
ControlText
Gets or sets the active text that is displayed for the current cell.
Declaration
public override string ControlText { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
Methods
CreateTextBox()
Creates the text box that is shown in-place in the cell when the user starts editing the cell.
Declaration
protected override TextBoxBase CreateTextBox()Returns
| Type | Description |
|---|---|
| System.Windows.Forms.TextBoxBase | Returns the new instance of the GridTextBoxControl. |
Overrides
OnDraw(Graphics, Rectangle, Int32, Int32, GridStyleInfo)
Calls the base method to draw the Textbox.
Declaration
protected override void OnDraw(Graphics g, Rectangle clientRectangle, int rowIndex, int colIndex, GridStyleInfo style)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Graphics | g | Points to the device context. |
| System.Drawing.Rectangle | clientRectangle | Size of the textbox cell. |
| System.Int32 | rowIndex | Row index of current cell. |
| System.Int32 | colIndex | Column index of current cell. |
| GridStyleInfo | style | The GridStyleInfo object that holds cell information. |
Overrides
Implements
System.IDisposable