Class CoveredCellInfoCollection
Represents the Class which holds all the information and maintains the operations related with Covered cells.
Implements
Inherited Members
Namespace: Syncfusion.UI.Xaml.CellGrid
Assembly: Syncfusion.SfCellGrid.WPF.dll
Syntax
public class CoveredCellInfoCollection : CellSpanInfoCollection<CoveredCellInfo>, IList<CoveredCellInfo>, ICollection<CoveredCellInfo>, IEnumerable<CoveredCellInfo>, IEnumerable, ISupportInitialize, ICoveredCellsProvider, IDisposable
Constructors
CoveredCellInfoCollection(SfCellGrid)
Initializes a new instance of the CoveredCellInfoCollection class.
Declaration
public CoveredCellInfoCollection(SfCellGrid grid)
Parameters
Type | Name | Description |
---|---|---|
SfCellGrid | grid | An instance of SfCellGrid |
Properties
Ranges
Gets the value indicating the list of selected ranges in grid.
Declaration
public GridRangeInfoList Ranges { get; }
Property Value
Type | Description |
---|---|
GridRangeInfoList | List of selected ranges. |
Methods
Added(CoveredCellInfo)
Declaration
protected override void Added(CoveredCellInfo item)
Parameters
Type | Name | Description |
---|---|---|
CoveredCellInfo | item |
Overrides
Clear()
Declaration
public override void Clear()
Overrides
Clear(GridRangeInfo)
Clears the covered cells in the given range.
Declaration
public void Clear(GridRangeInfo range)
Parameters
Type | Name | Description |
---|---|---|
GridRangeInfo | range | Specified range. |
CollectionModified(List<CoveredCellInfo>)
Updates the CoveredCells Ranges
Declaration
protected override void CollectionModified(List<CoveredCellInfo> spanCollection)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<CoveredCellInfo> | spanCollection | Collection of CoveredCells |
Overrides
Dispose()
Call the Dispose and SuppressFinalize method for dipose the instance of CoveredCellInfoCollection class.
Declaration
public void Dispose()
Dispose(Boolean)
Dispose the live resources used by the CoveredCellInfoCollection class.
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | disposing | Dispose the instance, if it is True |
Find(Int32, Int32, out GridRangeInfo)
Gets a covered cell from the CoveredCellsProvider includes the specified cells row and column index or if there is no covered range for the cell the method returns a cell range for the given row and column index.
Declaration
public bool Find(int rowIndex, int columnIndex, out GridRangeInfo coveredRange)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | rowIndex | Index of the row. |
System.Int32 | columnIndex | Index of the column. |
GridRangeInfo | coveredRange | The resulting covered range. If there is no covered range for the cell this range will return GridRangeInfo.Cell(rowIndex, columnIndex) |
Returns
Type | Description |
---|---|
System.Boolean | true if a covered cell was found; otherwise false. |
GetCoveredCell(Int32, Int32)
Gets a covered cell from the CoveredCellsProvider that includes the specified cells row and column index.
Declaration
public CoveredCellInfo GetCoveredCell(int rowIndex, int columnIndex)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | rowIndex | Specified row index. |
System.Int32 | columnIndex | Specified column index. |
Returns
Type | Description |
---|---|
CoveredCellInfo | An instance of CoveredCellInfo. |
IsCoveredCell(Int32, Int32)
Retruns true if the given cell is covered cell.
Declaration
public bool IsCoveredCell(int rowIndex, int columnIndex)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | rowIndex | Row index of the specified cell. |
System.Int32 | columnIndex | Column index of the specified cell. |
Returns
Type | Description |
---|---|
System.Boolean | True or False. |
OnGetCellSpan(Int32, Int32, out CoveredCellInfo)
Declaration
protected override bool OnGetCellSpan(int rowIndex, int columnIndex, out CoveredCellInfo result)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | rowIndex | |
System.Int32 | columnIndex | |
CoveredCellInfo | result |
Returns
Type |
---|
System.Boolean |
Overrides
Removed(CoveredCellInfo)
Declaration
protected override void Removed(CoveredCellInfo item)
Parameters
Type | Name | Description |
---|---|---|
CoveredCellInfo | item |
Overrides
SetCoveredRanges(CoveredCellInfo, Boolean)
Declaration
public void SetCoveredRanges(CoveredCellInfo item, bool setOrReset)
Parameters
Type | Name | Description |
---|---|---|
CoveredCellInfo | item | |
System.Boolean | setOrReset |