Class GridCheckBoxCellModel

Implements the data / model part for a check box cell.

Inheritance
System.Object
NonFinalizeDisposable
Disposable
GridCellModelBase
GridCheckBoxCellModel
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
Assembly: Syncfusion.Grid.Windows.dll
Syntax
public class GridCheckBoxCellModel : GridCellModelBase, ISerializable, IDisposable
Remarks

You typically access cell models through the CellModels property of the GridModel class.

A GridCheckBoxCellModel can serve as model for several GridCheckBoxCellRenderer instances if there are several GridControlBase views for a GridModel.

Constructors

GridCheckBoxCellModel(GridModel)

Initializes a new GridCheckBoxCellModel object and stores a reference to the GridModel this cell belongs to.

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

GridCheckBoxCellModel(SerializationInfo, StreamingContext)

Initializes a new GridCheckBoxCellModel from a serialization stream.

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

An object that holds all the data needed to serialize or desterilize this instance.
System.Runtime.Serialization.StreamingContext context

Describes the source and destination of the serialized stream specified by info.

Properties

CheckBoxSize

Gets or sets CheckBoxSize. For internal use.

Declaration
public Size CheckBoxSize { get; set; }
Property Value
Type
System.Drawing.Size

Methods

ApplyFormattedText(GridStyleInfo, String, Int32)

Parses the display text and converts it into a cell value to be stored in the style object. GridStyleInfo.CultureInfo is used for parsing the string.

Declaration
public override bool ApplyFormattedText(GridStyleInfo style, string str, int textInfo)
Parameters
Type Name Description
GridStyleInfo style

The GridStyleInfo object that holds cell information.
System.String str

The input text to be parsed.
System.Int32 textInfo

TextInfo is a hint of who is calling, default is GridCellBaseTextInfo.DisplayText
Returns
Type Description
System.Boolean

True if value was parsed correctly and saved in style object as CellValue; False otherwise.
Overrides

CreateRenderer(GridControlBase)

Creates a GridCheckBoxCellRenderer for this cell model that is specific to the GridControlBase.

Declaration
public override GridCellRendererBase CreateRenderer(GridControlBase control)
Parameters
Type Name Description
GridControlBase control

The GridControlBase the cell renderer is created for.
Returns
Type Description
GridCellRendererBase

A new GridCheckBoxCellRenderer specific for a GridControlBase.
Overrides

OnQueryCanFloatCell(Int32, Int32, GridStyleInfo, GridQueryFloatCell)

Determines whether the cell supports floating over a neighboring cell or can be flooded by a previous cell.

Declaration
public override bool OnQueryCanFloatCell(int rowIndex, int colIndex, GridStyleInfo style, GridQueryFloatCell query)
Parameters
Type Name Description
System.Int32 rowIndex

The row index.
System.Int32 colIndex

The column index.
GridStyleInfo style

The GridStyleInfo object that holds cell information.
GridQueryFloatCell query

A GridQueryFloatCell value that specifies whether a cell is asked about support for floating over another cell or being flooded by a previous cell.
Returns
Type Description
System.Boolean

True if floating is possible; False otherwise.
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

The GridStyleInfo object that holds cell information.
GridQueryBounds queryBounds

The GridQueryBounds
Returns
Type Description
System.Drawing.Size

The optimal size of the cell.
Overrides

Implements

System.Runtime.Serialization.ISerializable
System.IDisposable