Class GridSelectedCellsCollection
Represents a class that maintains the collection of selected cells and its information.
Inheritance
Implements
Namespace: Syncfusion.UI.Xaml.Grid
Assembly: Syncfusion.SfGrid.UWP.dll
Syntax
public class GridSelectedCellsCollection : Object, IList<GridSelectedCellsInfo>, ICollection<GridSelectedCellsInfo>, IEnumerable<GridSelectedCellsInfo>, IEnumerable
Constructors
GridSelectedCellsCollection()
Initializes a new instance of GridSelectedCellsCollection class.
Declaration
public GridSelectedCellsCollection()
Properties
Count
Gets the number of cells info contained in the GridSelectedCellsCollection list.
Declaration
public int Count { get; }
Property Value
Type | Description |
---|---|
System.Int32 | The number of elements contained in the GridSelectedCellsCollection list. |
IsReadOnly
Gets a value that indicates whether the GridSelectedCellsCollection list is read only.
Declaration
public bool IsReadOnly { get; }
Property Value
Type | Description |
---|---|
System.Boolean | True if the GridSelectedCellsCollection list is read only; otherwise, false. |
Item[Int32]
Gets or sets the selected cells information at the specified index.
Declaration
public GridSelectedCellsInfo this[int index] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The index for retrieving the selected cell info. |
Property Value
Type | Description |
---|---|
GridSelectedCellsInfo | Returns the selected cells information at the specified index. |
Methods
Add(GridCellInfo)
Adds the specific cell info into the GridSelectedCellsCollection list.
Declaration
public void Add(GridCellInfo cellInfo)
Parameters
Type | Name | Description |
---|---|---|
GridCellInfo | cellInfo | The cell info to add. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when the cell info argument value is null. |
Add(GridSelectedCellsInfo)
Adds the specific cells info into the GridSelectedCellsCollection list.
Declaration
public void Add(GridSelectedCellsInfo cellsInfo)
Parameters
Type | Name | Description |
---|---|---|
GridSelectedCellsInfo | cellsInfo | The selected cells info to add. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when the cells info argument value is null. |
Clear()
Removes all elements from the GridSelectedCellsCollection list.
Declaration
public void Clear()
Contains(GridCellInfo)
Determines whether the specific cell info is in the GridSelectedCellsCollection list.
Declaration
public bool Contains(GridCellInfo cellInfo)
Parameters
Type | Name | Description |
---|---|---|
GridCellInfo | cellInfo | The cell info to locate in the GridSelectedCellsCollection list. |
Returns
Type | Description |
---|---|
System.Boolean | true if the cell info is found in the GridSelectedCellsCollection list; otherwise, false. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when the cell info argument value is null. |
Contains(GridSelectedCellsInfo)
Determines whether the specific cells info contains in the GridSelectedCellsCollection list.
Declaration
public bool Contains(GridSelectedCellsInfo cellsInfo)
Parameters
Type | Name | Description |
---|---|---|
GridSelectedCellsInfo | cellsInfo | The cells info to locate in the GridSelectedCellsCollection list. |
Returns
Type | Description |
---|---|
System.Boolean | true if the cells info is found in the GridSelectedCellsCollection list; otherwise, false. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when the cells info argument value is null. |
CopyTo(GridSelectedCellsInfo[], Int32)
Copies all the cells information to the specified destination array index.
Declaration
public void CopyTo(GridSelectedCellsInfo[] array, int arrayIndex)
Parameters
Type | Name | Description |
---|---|---|
GridSelectedCellsInfo[] | array | An One-dimensional array that is the destination of the elements copied from the current array. |
System.Int32 | arrayIndex | The index in array at which copying begins. |
GetEnumerator()
Gets an enumerator that iterates through the GridSelectedCellsCollection list.
Declaration
public IEnumerator<GridSelectedCellsInfo> GetEnumerator()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerator<GridSelectedCellsInfo> | The enumerator for the GridSelectedCellsCollection list. |
IndexOf(GridCellInfo)
Searches for the specified cell info and returns zero-based index of the first occurrence with in the GridSelectedCellsCollection.
Declaration
public int IndexOf(GridCellInfo cellInfo)
Parameters
Type | Name | Description |
---|---|---|
GridCellInfo | cellInfo | The corresponding cell info that locate in the internal selected cells list. |
Returns
Type | Description |
---|---|
System.Int32 | Returns the zero-based index of the first occurrence of selected cell info , if its found in the GridSelectedCellsCollection; otherwise, –1. |
IndexOf(GridSelectedCellsInfo)
Searches for the specified selected cells info and returns zero-based index of the first occurrence with in the GridSelectedCellsCollection.
Declaration
public int IndexOf(GridSelectedCellsInfo item)
Parameters
Type | Name | Description |
---|---|---|
GridSelectedCellsInfo | item | The selected cells info that locate in the internal selected cells list. |
Returns
Type | Description |
---|---|
System.Int32 | Returns the zero-based index of the first occurrence of selected cells info , if its found on the GridSelectedCellsCollection; otherwise, –1. |
Insert(Int32, GridCellInfo)
Inserts a specified cell info into the GridSelectedCellsCollection at the specified index.
Declaration
public void Insert(int index, GridCellInfo cellInfo)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | Zero-based index at which cell info should be inserted. |
GridCellInfo | cellInfo | The cell info to insert. |
Insert(Int32, GridSelectedCellsInfo)
Inserts a new cells info into the GridSelectedCellsCollection at the specified index.
Declaration
public void Insert(int index, GridSelectedCellsInfo newItem)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | Zero-based index at which cells information should be inserted. . |
GridSelectedCellsInfo | newItem | The new item to insert. |
Remove(GridCellInfo)
Removes the first occurrence of a specific cell info from the GridSelectedCellsCollection list.
Declaration
public bool Remove(GridCellInfo cellInfo)
Parameters
Type | Name | Description |
---|---|---|
GridCellInfo | cellInfo | The cell info to remove from the GridSelectedCellsCollection list. |
Returns
Type | Description |
---|---|
System.Boolean | true if the item removed; otherwise, false. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when the cell info argument value is null. |
Remove(GridSelectedCellsInfo)
Removes the first occurrence of a specific cells info from the GridSelectedCellsCollection list.
Declaration
public bool Remove(GridSelectedCellsInfo cellsInfo)
Parameters
Type | Name | Description |
---|---|---|
GridSelectedCellsInfo | cellsInfo | The cells info to remove from the GridSelectedCellsCollection list. |
Returns
Type | Description |
---|---|
System.Boolean | true if the cells info removed; otherwise, false. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when the cells info argument value is null. |
RemoveAt(Int32)
Removes the cells info at specified index of the GridSelectedCellsCollection.
Declaration
public void RemoveAt(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The zero-based index of the element to remove. |