Syncfusion.Windows.Forms.Grid Namespace : GridTextBoxCellRenderer Class

GridTextBoxCellRenderer Class

Implements the renderer part of a text box cell.
Object Model
GridTextBoxCellRenderer ClassGridCurrentCell ClassGridStyleInfo ClassGridCellButton ClassIGridDropDownContainer InterfaceIGridDropDownCellImp InterfaceIGridDropDownCellImp InterfaceGridControlBase ClassGridCellModelBase ClassGridStyleInfo Class
Use "text box" as identifier in CellType of a cells GridStyleInfo to associate this cell type with a cell.

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

The following table lists some characteristics about the text box cell type.

Item Description
CellType Text Box
Renderer GridTextBoxCellRenderer
Model GridTextBoxCellModel
XP Themes Support NA
Interactive Edit with Text Input
Control GridTextBoxControl
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 cell displays 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) Text Box (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 cells 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 (Syncfusion.Drawing.BrushInfo) Lets you specify a solid back color, gradient, or pattern style with both back and fore color 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 text from 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 feature has 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 programatically change Read-only cells by setting GridModel.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 or 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 or 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 value 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 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)

Inheritance Hierarchy

Syncfusion.Grid.Windows: 18.2460.0.44

See Also