Class GroupedHeaderCellModel

Implements the data or model part of a grouped column header with sort indicator.

Inheritance
System.Object
NonFinalizeDisposable
Disposable
GridCellModelBase
GridStaticCellModel
GridHeaderCellModel
GroupedHeaderCellModel
Implements
System.Runtime.Serialization.ISerializable
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.Windows.Forms.Grid.Grouping
Assembly: Syncfusion.Grid.Grouping.Windows.dll
Syntax
public class GroupedHeaderCellModel : GridHeaderCellModel, ISerializable, IDisposable
Remarks

You can 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

GroupedHeaderCellModel(GridModel)

Initializes a new instance of the GridSortColumnHeaderCellModel class with the specified grid.

Declaration
public GroupedHeaderCellModel(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.

GroupedHeaderCellModel(SerializationInfo, StreamingContext)

Initializes a new instance of the GridSortColumnHeaderCellModel class from a serialization stream.

Declaration
protected GroupedHeaderCellModel(SerializationInfo info, StreamingContext context)
Parameters
Type Name Description
System.Runtime.Serialization.SerializationInfo info

An object that holds all the data needed to serialize or deserialize 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

An instance of the GroupedHeaderCellRenderer class.
Overrides

GetFormattedText(GridStyleInfo, Object, Int32)

Overrides and gets the formated string for the specified object.

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

The textInfo is a hint who is calling, default is GridCellBaseTextInfo.DisplayText.
Returns
Type Description
System.String

The formatted text for the gives value.
Overrides

OnQueryPrefferedClientSize(Graphics, Int32, Int32, GridStyleInfo, GridQueryBounds)

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

The System.Drawing.Graphics context of the canvas.
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

Graphical bounds of the cell.
Returns
Type Description
System.Drawing.Size

The optimal size of the cell.
Overrides

Implements

System.Runtime.Serialization.ISerializable
System.IDisposable