Class GridSortColumnHeaderCellModel
Implements the data or model part of a column header with sort indicator.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Windows.Forms.Grid
Assembly: Syncfusion.Grid.Windows.dll
Syntax
public class GridSortColumnHeaderCellModel : GridHeaderCellModel, ISerializable, IDisposable
Remarks
You typically access cell models through the CellModels property of the GridModel class.
A GridSortColumnHeaderCellModel can serve as model for several GridSortColumnHeaderCellRenderer instances if there are several GridControlBase views for a GridModel.
See GridSortColumnHeaderCellRenderer for more detailed information about this cell type.
Constructors
GridSortColumnHeaderCellModel(GridModel)
Initializes a new instance ofGridSortColumnHeaderCellModel class and stores a reference to the GridModel this cell belongs to.
Declaration
public GridSortColumnHeaderCellModel(GridModel grid)
Parameters
Type | Name | Description |
---|---|---|
GridModel | grid | The GridModel for this cell model. |
Remarks
You typically access cell models through the CellModels property of the GridModel class.
GridSortColumnHeaderCellModel(SerializationInfo, StreamingContext)
Initializes a new instance ofGridSortColumnHeaderCellModel class from a serialization stream.
Declaration
protected GridSortColumnHeaderCellModel(SerializationInfo info, StreamingContext context)
Parameters
Type | Name | Description |
---|---|---|
System.Runtime.Serialization.SerializationInfo | info | An object that holds all the data needed to serialize or de-serialize this instance. |
System.Runtime.Serialization.StreamingContext | context | Describes the source and destination of the serialized stream specified by info. |
Methods
CreateRenderer(GridControlBase)
Creates a renderer for this cell model.
Declaration
public override GridCellRendererBase CreateRenderer(GridControlBase control)
Parameters
Type | Name | Description |
---|---|---|
GridControlBase | control | The grid control. |
Returns
Type | Description |
---|---|
GridCellRendererBase | Cell renderer. |
Overrides
GetFormattedText(GridStyleInfo, Object, Int32)
Overridden to get the style formatted text fromGetFormattedText(Object) method.
Declaration
public override string GetFormattedText(GridStyleInfo style, object value, int textInfo)
Parameters
Type | Name | Description |
---|---|---|
GridStyleInfo | style | The GridStyleInfo object that holds cell information. |
System.Object | value | The value to format. |
System.Int32 | textInfo | textInfo is a hint who is calling, default is GridCellBaseTextInfo.DisplayText. |
Returns
Type | Description |
---|---|
System.String | The formatted test for the gives value. |
Overrides
OnQueryPrefferedClientSize(Graphics, Int32, Int32, GridStyleInfo, GridQueryBounds)
Overridden to calculate 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 | The System.Drawing.Graphics context of the canvas. |
System.Int32 | rowIndex | The row index. |
System.Int32 | colIndex | The column index. |
GridStyleInfo | style | The GridStyleInfo object that holds cell information. |
GridQueryBounds | queryBounds | graphical bounds |
Returns
Type | Description |
---|---|
System.Drawing.Size | The optimal size of the cell. |