Class GridHeaderCellRenderer
Implements the renderer as part of a column or row header.
Inheritance
Inherited Members
Namespace: Syncfusion.Windows.Forms.Grid
Assembly: Syncfusion.Grid.Windows.dll
Syntax
public class GridHeaderCellRenderer : GridStaticCellRenderer, IQueryFocusInside, IGridDropDownCell, IPopupParent, IPopupItem, IDisposableRemarks
There can be several renderers associated with one GridHeaderCellModel 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 | GridHeaderCellRenderer |
| Model | GridHeaderCellModel |
| 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: TextBox) |
| 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: null) |
| 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 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 can 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 / 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 a 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 a individual cell when merging cells 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
GridHeaderCellRenderer(GridControlBase, GridCellModelBase)
Initializes a new GridHeaderCellRenderer object for the given GridControlBase and GridCellModelBase.
Declaration
public GridHeaderCellRenderer(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.
Methods
Dispose(Boolean)
Disposes the unmanaged resources.
Declaration
protected override void Dispose(bool disposing)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | disposing |
Overrides
DrawMetroCaptionRowStyle(Graphics, Rectangle, ThemedHeaderDrawing.HeaderState)
Draws Metro header skins for CaptionRowHeader
Declaration
public void DrawMetroCaptionRowStyle(Graphics g, Rectangle rect, ThemedHeaderDrawing.HeaderState state)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Graphics | g | A System.Drawing.Graphics object. |
| System.Drawing.Rectangle | rect | A System.Drawing.Rectangle object that represents the drawing area. |
| ThemedHeaderDrawing.HeaderState | state | The current state of the header. |
DrawMetroHeaderStyle(Graphics, Rectangle, ThemedHeaderDrawing.HeaderState)
Draws Metro header skins
Declaration
public void DrawMetroHeaderStyle(Graphics g, Rectangle rect, ThemedHeaderDrawing.HeaderState state)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Graphics | g | A System.Drawing.Graphics object. |
| System.Drawing.Rectangle | rect | A System.Drawing.Rectangle object that represents the drawing area. |
| ThemedHeaderDrawing.HeaderState | state | The current state of the header. |
OnDraw(Graphics, Rectangle, Int32, Int32, GridStyleInfo)
Draw the Header 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 | A System.Drawing.Rectangle has location and size of the header cell. |
| System.Int32 | rowIndex | Current row index. |
| System.Int32 | colIndex | Current column index. |
| GridStyleInfo | style | Grid view style information. |
Overrides
OnDrawCellBackground(GridDrawCellBackgroundEventArgs)
Declaration
protected override void OnDrawCellBackground(GridDrawCellBackgroundEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| GridDrawCellBackgroundEventArgs | e |
Overrides
OnDrawDisplayText(Graphics, Rectangle, Int32, Int32, GridStyleInfo)
This method is called from OnDraw(Graphics, Rectangle, Int32, Int32, GridStyleInfo) to draw the face text of the header cell after its background has been drawn.
Declaration
protected virtual void OnDrawDisplayText(Graphics g, Rectangle textRectangle, int rowIndex, int colIndex, GridStyleInfo style)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Graphics | g | Points to the device context. |
| System.Drawing.Rectangle | textRectangle | Specifies the text rectangle. It is the cell rectangle without buttons, borders, or text margins. |
| System.Int32 | rowIndex | Specifies the row id. |
| System.Int32 | colIndex | Specifies the column id. |
| GridStyleInfo | style | A reference to the style object of the cell. |
OnHitTest(Int32, Int32, MouseEventArgs, IMouseController)
This method is called to determine whether the cell renderer wants to receive mouse events for the give cell at the given coordinates.
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 current controller 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
OnMouseDown(Int32, Int32, MouseEventArgs)
Raises the System.Windows.Forms.Control.MouseDown event.
Declaration
protected override void OnMouseDown(int rowIndex, int colIndex, MouseEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | Row index of current cell. |
| System.Int32 | colIndex | Column index of current cell. |
| System.Windows.Forms.MouseEventArgs | e | An System.Windows.Forms.MouseEventArgs that contains event data. |
Overrides
OnMouseHover(Int32, Int32, MouseEventArgs)
Raises the System.Windows.Forms.Control.MouseHover event.
Declaration
protected override void OnMouseHover(int rowIndex, int colIndex, MouseEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | Row index of current cell. |
| System.Int32 | colIndex | Column index of current cell. |
| System.Windows.Forms.MouseEventArgs | e | An System.Windows.Forms.MouseEventArgs that contains event data. |
Overrides
OnMouseHoverLeave(Int32, Int32, EventArgs)
Raises the OnMouseHoverLeave(Int32, Int32, EventArgs) event.
Declaration
protected override void OnMouseHoverLeave(int rowIndex, int colIndex, EventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | Row index of current cell. |
| System.Int32 | colIndex | Column index of current cell. |
| System.EventArgs | e | An System.Windows.Forms.MouseEventArgs that contains event data. |
Overrides
OnMouseMove(Int32, Int32, MouseEventArgs)
Declaration
protected override void OnMouseMove(int rowIndex, int colIndex, MouseEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | |
| System.Int32 | colIndex | |
| System.Windows.Forms.MouseEventArgs | e |
Overrides
OnMouseUp(Int32, Int32, MouseEventArgs)
Raises the System.Windows.Forms.Control.MouseUp event.
Declaration
protected override void OnMouseUp(int rowIndex, int colIndex, MouseEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | Row index of current cell. |
| System.Int32 | colIndex | Column index of current cell. |
| System.Windows.Forms.MouseEventArgs | e | An System.Windows.Forms.MouseEventArgs that contains event data. |
Overrides
OnOutlineCurrentCell(Graphics, Rectangle)
Draw the outline border for header cells.
Declaration
protected override void OnOutlineCurrentCell(Graphics g, Rectangle r)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Graphics | g | Points to the device context. |
| System.Drawing.Rectangle | r | Size of the header cell rectangle. |
Overrides
OnPrepareViewStyleInfo(GridPrepareViewStyleInfoEventArgs)
Allows custom formatting of a cell by changing its style object.
Declaration
public override void OnPrepareViewStyleInfo(GridPrepareViewStyleInfoEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| GridPrepareViewStyleInfoEventArgs | e | Event data. |
Overrides
UnwireGrid()
Resets up mouse event hooks with the grid.
Declaration
protected virtual void UnwireGrid()WireGrid()
Sets up mouse event hooks with the grid.
Declaration
protected virtual void WireGrid()