Class GridTableRowHeaderCellRenderer
Implements the renderer part of a row header.
Inheritance
Inherited Members
Namespace: Syncfusion.Windows.Forms.Grid.Grouping
Assembly: Syncfusion.Grid.Grouping.Windows.dll
Syntax
public class GridTableRowHeaderCellRenderer : GridTableHeaderCellRenderer, IQueryFocusInside, IGridDropDownCell, IPopupParent, IPopupItem, IDisposableRemarks
There can be several renderer associated with one GridTableRowHeaderCellModel if several views display the same GridModel.
The header cell is XP Themes enabled. It will be drawn themed if ThemesEnabled is true.
The following table lists some characteristics about the Header cell type:
| Item | Description |
|---|---|
| CellType | Header |
| Renderer | GridTableHeaderCellRenderer |
| Model | GridTableHeaderCellModel |
| XP Themes Support | Yes |
| Interactive | Click Only |
| 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 |
|---|---|
| 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) | When set to 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) |
| CellTipText (System.String) | ToolTip text to be displayed when user hovers mouse over cell. (Default: String.Empty) |
| CellType (System.String) | Header (Default: Text Box) |
| CellValue (System.Object) | If empty, the standard header text will be drawn as specified with the NumberedRowHeaders and NumberedColHeaders properties in GridModel. If CellValue is not NULL, the cell value will be displayed as header text. (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: NNULL) |
| Enabled (System.Boolean) | Specifies if the header cell can be activated as current cell when the user clicks onto the header. Usually you do not want a header to be activated as current cell unless you want to have editing capabilities such as allowing a user to rename header text in place. (You would have to implement a custom header cell for this.) (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) |
| Font (GridFontInfo) | The font for drawing text. (Default: GridFontInfo.Default) |
| Format (System.String) | Gets or sets the format mask for formatting the cell's 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 a 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. If 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) |
| MergeCell (GridMergeCellDirection) | Specifies merge behavior for an individual cell when the merging cell's feature has been enabled in a GridModel with MergeCellsMode. (Default: GridMergeCellDirection.None) |
| Text (System.String) | If empty, the standard header text will be drawn as specified with the NumberedRowHeaders and NumberedColHeaders properties in GridModel. If CellValue is not NULL, the cell value will be displayed as header text. (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) |
| Themed (System.Boolean) | Specifies if cell should be drawn using Windows XP themes when ThemesEnabled has been set. (Default: True) |
| Trimming (System.Drawing.StringTrimming) | Indicates how text is trimmed when it exceeds the edges of the cell text rectangle. (Default: StringTrimming.Character) |
| VerticalAlignment (GridVerticalAlignment) | Specifies vertical alignment of text in the cell. (Default: GridVerticalAlignment.Top) |
| WrapText (System.Boolean) | Specifies if text should be wrapped when it does not fit into a single line. (Default: True) |
Constructors
GridTableRowHeaderCellRenderer(GridControlBase, GridCellModelBase)
Initializes a new instance of the GridCheckBoxCellRenderer class for the given GridControlBase and GridCellModelBase.
Declaration
public GridTableRowHeaderCellRenderer(GridControlBase grid, GridCellModelBase cellModel)Parameters
| Type | Name | Description |
|---|---|---|
| GridControlBase | grid | The GridControlBase that displays this cell renderer. |
| GridCellModelBase | cellModel | The GridCheckBoxCellModel that holds data for this cell renderer that should be shared among views. |
Remarks
References to GridControlBase and GridCellModelBase will be saved.
Properties
Grid
Gets a value of reference to the parent grid.
Declaration
public GridTableControl Grid { get; }Property Value
| Type | Description |
|---|---|
| GridTableControl |
Methods
OnClick(Int32, Int32, MouseEventArgs)
Overrides and triggered when the System.Windows.Forms.Control.Click event is done.
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 | A System.Windows.Forms.MouseEventArgs contains the event data. |
Overrides
OnDraw(Graphics, Rectangle, Int32, Int32, GridStyleInfo)
This method is called from the cell renderer's draw method to draw the contents of the client bounds for the cell, e.g. the text for a static cell.
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 | Specifies the client rectangle. It is the cell rectangle without buttons and borders. |
| System.Int32 | rowIndex | The row index. |
| System.Int32 | colIndex | The column index. |
| GridStyleInfo | style | An instance of the GridStyleInfo that holds the values of style properties. |
Overrides
Remarks
When drawing cells, it is necessary to determine if the specified cell (with rowIndex and colIndex) is the current cell and if it is active.
If your control is associated with a control and supports in-place editing and the specified cell is the current cell, you should position the control. Take a look at the GridTextBoxCellRenderer implementation of this method for an example.
Otherwise, you can simply draw the cell.
OnDrawDisplayText(Graphics, Rectangle, Int32, Int32, GridStyleInfo)
Overrides and draws the display text on the headers. its background has been drawn.
Declaration
protected override void OnDrawDisplayText(Graphics g, Rectangle textRectangle, int rowIndex, int colIndex, GridStyleInfo style)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Graphics | g | The instance of the System.Drawing.Graphics class. |
| System.Drawing.Rectangle | textRectangle | Specifies the text rectangle. It is the cell rectangle without buttons and borders and text margins. |
| System.Int32 | rowIndex | The row index. |
| System.Int32 | colIndex | The column index. |
| GridStyleInfo | style | An instance of the GridStyleInfo that holds the values of style properties. |
Overrides
OnHitTest(Int32, Int32, MouseEventArgs, IMouseController)
Overrides and triggered to determine whether the mouse events should be handled by the renderer at the given coordinates for the specified cell.
Declaration
protected override int OnHitTest(int rowIndex, int colIndex, MouseEventArgs e, IMouseController controller)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | The row index. |
| System.Int32 | colIndex | The column index. |
| System.Windows.Forms.MouseEventArgs | e | A System.Windows.Forms.MouseEventArgs with data about the mouse event. |
| IMouseController | controller | The IMouseController requested to handle this mouse event. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Non-zero hit context value if you request to handle the mouse event; zero if you vote not to handle the mouse event. |
Overrides
PaintIcon(Graphics, Rectangle, Point, Bitmap, Color)
Paints the specified bitmap substituting black pixels with a new color.
Declaration
public static Rectangle PaintIcon(Graphics g, Rectangle bounds, Point offset, Bitmap bmp, Color foreColor)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Graphics | g | The instance of the System.Drawing.Graphics class. |
| System.Drawing.Rectangle | bounds | A System.DrawingRectangle instance which contains the boundary data of the rectangle. |
| System.Drawing.Point | offset | A System.DrawingPoint that specifies pixel to offset the bitmap from its origin point. |
| System.Drawing.Bitmap | bmp | The Bitmap to be drawn on the screen. |
| System.Drawing.Color | foreColor | The new color used to substitute black pixels. |
Returns
| Type | Description |
|---|---|
| System.Drawing.Rectangle | A Rectangle which contains the boundary data of the drawn bitmap. |
Remarks
The PaintIcon routine will substitute black pixels of the original bitmap and draw them with the specified fore color. The bitmap is centered inside the specified bounds. Use the offset if you want to display a "pressed button" state. If the button is pressed, specify offset = new Point(1, 1).
PaintIcon(Graphics, Rectangle, Point, String, Color)
Loads the bitmap from manifest and paint it substituting black pixels with a new color.
Declaration
public static void PaintIcon(Graphics g, Rectangle bounds, Point offset, string bitmapName, Color foreColor)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Graphics | g | The instance of the System.Drawing.Graphics class. |
| System.Drawing.Rectangle | bounds | A System.DrawingRectangle instance which contains the boundary data of the rectangle. |
| System.Drawing.Point | offset | A System.DrawingPoint that specifies pixel to offset the bitmap from its origin point. |
| System.String | bitmapName | The name of the bitmap. |
| System.Drawing.Color | foreColor | The new color used to substitute black pixels. |
Remarks
A Rectangle which contains the boundary data of the drawn bitmap. The PaintIcon routine will substitute black pixels of the original bitmap and draw them with the specified fore color. The bitmap is centered inside the specified bounds. Use the offset if you want to display a "pressed button" state. If the button is pressed, specify offset = new Point(1, 1).