Class GridTableColumnHeaderCellModel
Implements the DataModel part of a column header with sort indicator.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Windows.Forms.Grid.Grouping
Assembly: Syncfusion.Grid.Grouping.Windows.dll
Syntax
public class GridTableColumnHeaderCellModel : GridHeaderCellModel, ISerializable, IDisposableRemarks
You can typically access cell models through the CellModels property of the GridModel class.
A GridTableColumnHeaderCellModel can serve as model for several GridTableColumnHeaderCellRenderer instances if there are several GridControlBase views for a GridModel.
See GridTableColumnHeaderCellRenderer for more detailed information about this cell type.
Constructors
GridTableColumnHeaderCellModel(GridModel)
Initializes a new instance of the GridTableColumnHeaderCellModel class. and stores a reference to the GridModel this cell belongs to.
Declaration
public GridTableColumnHeaderCellModel(GridModel grid)Parameters
| Type | Name | Description |
|---|---|---|
| GridModel | grid | The GridModel for this cell model. |
Remarks
You can typically access cell models through the CellModels property of the GridModel class.
GridTableColumnHeaderCellModel(SerializationInfo, StreamingContext)
Initializes a new instance of the GridTableColumnHeaderCellModel class from a serialization stream.
Declaration
protected GridTableColumnHeaderCellModel(SerializationInfo info, StreamingContext context)Parameters
| Type | Name | Description |
|---|---|---|
| System.Runtime.Serialization.SerializationInfo | info | An instance of theSystem.Runtime.Serialization.SerializationInfo that holds all the data needed to serialize or deserialize this instance. |
| System.Runtime.Serialization.StreamingContext | context | An instance of the System.Runtime.Serialization.StreamingContext that describes the source and destination of the serialized stream specified by |
Methods
CreateRenderer(GridControlBase)
Overrides and creates a cell renderer for GridTableColumnHeaderCellModel class.
Declaration
public override GridCellRendererBase CreateRenderer(GridControlBase control)Parameters
| Type | Name | Description |
|---|---|---|
| GridControlBase | control | The grid control. |
Returns
| Type | Description |
|---|---|
| GridCellRendererBase | An instance of the GridTableColumnHeaderCellRenderer class. |
Overrides
GetFormattedText(GridStyleInfo, Object, Int32)
Overrides and gets the formatted string.
Declaration
public override string GetFormattedText(GridStyleInfo style, object value, int textInfo)Parameters
| Type | Name | Description |
|---|---|---|
| GridStyleInfo | style | An instance of the GridStyleInfo that holds the values of style properties. |
| System.Object | value | The value to be formatted. |
| System.Int32 | textInfo | Specifies the hint of who is calling, By default is DisplayText calls. |
Returns
| Type | Description |
|---|---|
| System.String | The formatted text of the specified value. |
Overrides
OnQueryPrefferedClientSize(Graphics, Int32, Int32, GridStyleInfo, GridQueryBounds)
Overrides and calculates the preferred size of the cell based on its contents without margins and any buttons.
Declaration
protected override Size OnQueryPrefferedClientSize(Graphics g, int rowIndex, int colIndex, GridStyleInfo style, GridQueryBounds queryBounds)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Graphics | g | An instance of the System.Drawing.Graphics class. |
| 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. |
| GridQueryBounds | queryBounds | The grid query bounds |
Returns
| Type | Description |
|---|---|
| System.Drawing.Size | The optimal size of the cell. |