Syncfusion.Grid.Windows
Members 


Syncfusion.Windows.Forms.Grid Namespace : GridRichTextBoxCellRenderer Class

GridRichTextBoxCellRenderer Class

Implements the renderer part of a rich text cell.
Object Model
GridRichTextBoxCellRenderer ClassGridCurrentCell ClassGridStyleInfo ClassGridCellButton ClassGridDropDownContainer ClassIGridDropDownCellImp InterfaceIGridDropDownCellImp InterfaceGridControlBase ClassGridCellModelBase ClassGridStyleInfo Class
Syntax
Remarks
Use "RichText" as identifier in CellType of a cells GridStyleInfo to associate this cell type with a cell.

This renderer supports editing the contents of the rich text with a drop-down panel. When the user drops the panel, a GridRichTextEntryPanel is shown and the user can format the text and then accept changes by pressing "Save" button.

The following table lists some characteristics about the RichText cell type.

Item Description
CellType RichText
Renderer GridRichTextBoxCellRenderer
Model GridRichTextBoxCellModel
XP Themes Support Yes
Interactive Edit with DropDown Panel
DropDown Control GridRichTextEntryPanel
Floating Support No
Base Type GridStaticCellRenderer

The cell's behavior and appearance can be customized with the following properties of the GridStyleInfo class.

PropertyName Description
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) RichText (Default: TextBox)
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 the user can click on any cell button elements in this renderer. (Default: True)
GridStyleInfo.CultureInfo (System.Globalization.CultureInfo) The culture information holds rules for parsing and formatting the cell's value. (Default: NULL)
GridStyleInfo.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)
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.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.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 cell buttons. 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.Themed (System.Boolean) Specifies if cell should be drawn using Windows XP themes when GridControlBase.ThemesEnabled has been set. (Default: True)
GridStyleInfo.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)

Inheritance Hierarchy

System.Object
   Syncfusion.ComponentModel.NonFinalizeDisposable
      Syncfusion.Windows.Forms.Grid.GridCellRendererBase
         Syncfusion.Windows.Forms.Grid.GridRichTextBoxCellRenderer

AssemblyVersion

Syncfusion.Grid.Windows: 17.1460.0.47

See Also