menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridCoveredCellPool - API Reference

    Show / Hide Table of Contents

    Class GridCoveredCellPool

    Implements the storage for covered cells in the grid and allows a fast way to look up if a specific cell is part of a covered range.

    Inheritance
    System.Object
    GridCoveredCellPool
    Implements
    System.Runtime.Serialization.ISerializable
    Inherited Members
    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 GridCoveredCellPool : ISerializable

    Constructors

    GridCoveredCellPool()

    Initializes a new instance of GridCoveredCellPool class.

    Declaration
    public GridCoveredCellPool()

    GridCoveredCellPool(SerializationInfo, StreamingContext)

    Initializes a new GridCoveredCellPool from a serialization stream.

    Declaration
    protected GridCoveredCellPool(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

    Clear()

    Clears all covered ranges from this pool.

    Declaration
    public void Clear()

    GetObjectData(SerializationInfo, StreamingContext)

    Implements the ISerializable interface and returns the data needed to serialize the GridCoveredCellPool.

    Declaration
    public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
    Parameters
    Type Name Description
    System.Runtime.Serialization.SerializationInfo info

    A SerializationInfo object containing the information required to serialize the object.

    System.Runtime.Serialization.StreamingContext context

    A StreamingContext object containing the source and destination of the serialized stream.

    GetSpanCellsRowCol(Int32, Int32, out GridRangeInfo)

    Determines the covered range information for a cell specified with row and column index.

    Declaration
    public bool GetSpanCellsRowCol(int rowIndex, int colIndex, out GridRangeInfo range)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    The row index.

    System.Int32 colIndex

    The column index.

    GridRangeInfo range

    A place holder where covered cell's range information is returned.

    Returns
    Type Description
    System.Boolean

    True if a covered cell was found; False otherwise.

    InitFromRangeList(GridRangeInfoList)

    Initializes the pool with covered range information from a range list.

    Declaration
    public void InitFromRangeList(GridRangeInfoList ranges)
    Parameters
    Type Name Description
    GridRangeInfoList ranges

    The range list with all covered cells.

    ResetSpanCells(GridRangeInfo)

    Resets spanned cells in the specified range.

    Declaration
    public bool ResetSpanCells(GridRangeInfo range)
    Parameters
    Type Name Description
    GridRangeInfo range

    The range to be reset.

    Returns
    Type Description
    System.Boolean

    True if changes were made; False if there were no covered ranges.

    ResetSpanCells(GridRangeInfo, Boolean)

    Resets spanned cells in the specified range.

    Declaration
    public bool ResetSpanCells(GridRangeInfo range, bool checkContainment)
    Parameters
    Type Name Description
    GridRangeInfo range

    The range to be reset.

    System.Boolean checkContainment

    True if only covered cells should be reset that are contained in the range

    Returns
    Type Description
    System.Boolean

    True if changes were made; False if there were no covered ranges.

    StoreSpanCells(GridRangeInfo)

    Saves the covered cell's information for a specific range.

    Declaration
    public bool StoreSpanCells(GridRangeInfo range)
    Parameters
    Type Name Description
    GridRangeInfo range

    The covered cell's range to be saved.

    Returns
    Type Description
    System.Boolean

    True if successful; False if there was an error or a range was already existing.

    Exceptions
    Type Condition
    System.ArgumentException

    if rangeis Null or cells not in the range.

    Implements

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