WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridCheckBoxCellModel - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    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
    GridCellModelBase.Dispose()
    GridCellModelBase.OnBindingContextChanged(EventArgs)
    GridCellModelBase.GetLocalizedString(String)
    GridCellModelBase.OnModelDeserialization(Object, GridModel)
    GridCellModelBase.GetObjectData(SerializationInfo, StreamingContext)
    GridCellModelBase.CreateCopy(GridModel)
    GridCellModelBase.SubtractBorders(Rectangle, GridStyleInfo, Boolean)
    GridCellModelBase.SubtractBorders(Rectangle, GridStyleInfo)
    GridCellModelBase.CalculatePreferredCellSize(Graphics, Int32, Int32, GridStyleInfo, GridQueryBounds)
    GridCellModelBase.MeasureSampleWString(Graphics, Font)
    GridCellModelBase.GetCellSize(Int32, Int32)
    GridCellModelBase.GetCellClientSize(Int32, Int32, GridStyleInfo)
    GridCellModelBase.OnQueryCanMergeCell(Int32, Int32, GridStyleInfo, GridMergeCellDirection)
    GridCellModelBase.GetFormattedOrActiveTextAt(Int32, Int32, GridStyleInfo)
    GridCellModelBase.GetFormattedText(GridStyleInfo, Object, Int32)
    GridCellModelBase.GetText(GridStyleInfo, Object)
    GridCellModelBase.ApplyText(GridStyleInfo, String)
    GridCellModelBase.SetActiveText(Int32, Int32, String)
    GridCellModelBase.GetActiveText(Int32, Int32)
    GridCellModelBase.OnActiveTextChanged(GridCellEventArgs)
    GridCellModelBase.ResetActiveText(Int32, Int32)
    GridCellModelBase.GetPropertyDescriptor(GridStyleInfo)
    GridCellModelBase.GetTypeConverter(GridStyleInfo)
    GridCellModelBase.IsDisposing
    GridCellModelBase.IsDisposed
    GridCellModelBase.ForceCoveredCellFullBounds
    GridCellModelBase.BindingContext
    GridCellModelBase.Description
    GridCellModelBase.SerializeSchemeVersion
    GridCellModelBase.Grid
    GridCellModelBase.ButtonBarSize
    GridCellModelBase.MeasureEmptyCellString
    GridCellModelBase.ActiveTextChanged
    NonFinalizeDisposable.Dispose(Boolean)
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    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 Description
    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
    GridCellModelBase.ApplyFormattedText(GridStyleInfo, String, Int32)

    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
    GridCellModelBase.CreateRenderer(GridControlBase)

    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
    GridCellModelBase.OnQueryCanFloatCell(Int32, Int32, GridStyleInfo, GridQueryFloatCell)

    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
    GridCellModelBase.OnQueryPrefferedClientSize(Graphics, Int32, Int32, GridStyleInfo, GridQueryBounds)

    Implements

    System.Runtime.Serialization.ISerializable
    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved