Syncfusion.Windows.Forms.Grid Namespace : GridDataBoundRowHeaderCellRenderer Class

GridDataBoundRowHeaderCellRenderer Class

Implements the renderer part of a row header cell in a GridDataBoundGrid. The row header cell will display an arrow for the current row, a star for the append row, and a pencil when the row is being edited.
Object Model
GridDataBoundRowHeaderCellRenderer ClassGridCurrentCell ClassGridStyleInfo ClassGridCellButton ClassIGridDropDownContainer InterfaceIGridDropDownCellImp InterfaceIGridDropDownCellImp InterfaceGridControlBase ClassGridCellModelBase ClassGridStyleInfo Class
Defines the renderer part of a row header cell. A renderer is created for each GridCellModelBase and GridControlBase. There can be several renderers associated with one GridDataBoundRowHeaderCellRenderer if several views display the same GridModel.

The header cell is XP Themes enabled. It will be drawn themed if GridControlBase.ThemesEnabled is True.

The GridDataBoundGrid registers "RowHeaderCell" as identifier in GridStyleInfo.CellType of a cell's GridStyleInfo to associate this cell type with a cell.

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) When set to GridCellAppearance.Flat, the header will be drawn with slightly raised edges typical for cell headers. If the grid is XP Themes enabled, the headers will be drawn with XP Themes look. If you specify Sunken or Raised, the header will be drawn with sunken or raised edges and not XP Themed. (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) RowHeaderCell (Default: TextBox)
GridStyleInfo.Enabled (System.Boolean) Specifies if the cell can be activated as the current cell when the user clicks onto the header. Usually you do not want a header to be activated as the current cell unless you want to have editing capabilities like allowing user to rename header text in place. Such renaming functionality needs to be implemented in a derived class. (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 back color, gradient, or pattern style with both back and fore color for a cell's background. If the grid is XP Themes enabled, this color will be ignored and the header will be drawn with default XP Themes header background. (Default: SystemColors.Window)
GridStyleInfo.TextColor (System.Drawing.Color) Lets you specify the color of the arrow, pencil, or star icon. (Default: SystemColors.WindowText)
GridStyleInfo.TextMargins (GridMarginsInfo) When drawing this header cell this specifies the minimum empty area between the text rectangle without borders and the icon. The icon will be centered inside the remaining rectangle. (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)

Inheritance Hierarchy



Syncfusion.Grid.Windows: 17.1460.0.47

See Also