Class SpreadsheetCellRendererCollection
Represents a collection of SpreadsheetCellRendererBase objects in the view.
Implements
Namespace: Syncfusion.UI.Xaml.Spreadsheet.CellRenderer
Assembly: Syncfusion.SfSpreadsheet.UWP.dll
Syntax
public class SpreadsheetCellRendererCollection : Disposable, IDisposable, ICollection, IEnumerable
Remarks
The SpreadsheetCellRendererCollection uses standard Add(String, ISpreadsheetCellRenderer) and Remove(String) methods to manipulate the collection. Use the Contains method to determine if a specific cell type exists in the collection.
Constructors
SpreadsheetCellRendererCollection(SpreadsheetGrid)
Initializes a new instance of the SpreadsheetCellRendererCollection class.
Declaration
public SpreadsheetCellRendererCollection(SpreadsheetGrid cellgrid)
Parameters
Type | Name | Description |
---|---|---|
SpreadsheetGrid | cellgrid | An instance of SpreadsheetGrid. |
Properties
Count
Gets the number of elements contained in the System.Collections.ICollection.
Declaration
public int Count { get; }
Property Value
Type | Description |
---|---|
System.Int32 | The number of elements contained in the System.Collections.ICollection. |
IsSynchronized
Gets a value indicating whether access to the System.Collections.ICollection is synchronized (thread safe).
Declaration
public bool IsSynchronized { get; }
Property Value
Type | Description |
---|---|
System.Boolean | true if access to the System.Collections.ICollection is synchronized (thread safe); otherwise, false. |
Item[String]
Gets or sets the value indicating the Indexer which will return the renderer for the corresponding key value.
Declaration
public ISpreadsheetCellRenderer this[string key] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
System.String | key | An Index of the renderer. |
Property Value
Type | Description |
---|---|
ISpreadsheetCellRenderer | An instance of ISpreadsheetCellRenderer. |
Keys
Gets the value indicating the keys in the renderer collection.
Declaration
public ICollection Keys { get; }
Property Value
Type | Description |
---|---|
System.Collections.ICollection | Keys in the hashtable. |
SyncRoot
Gets an object that can be used to synchronize access to the System.Collections.ICollection.
Declaration
public object SyncRoot { get; }
Property Value
Type | Description |
---|---|
System.Object | An object that can be used to synchronize access to the System.Collections.ICollection. |
Values
Gets the value indicating the renderers in the collection.
Declaration
public ICollection Values { get; }
Property Value
Type | Description |
---|---|
System.Collections.ICollection | The values in the hashtable. |
Methods
Add(String, ISpreadsheetCellRenderer)
Add the Renderers to the Renderer dictionary.
Declaration
public void Add(string key, ISpreadsheetCellRenderer renderer)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | Key to the SpreadsheetCellRenderer Collection. |
ISpreadsheetCellRenderer | renderer | An instance of ISpreadsheetCellRenderer. |
Clear()
Clears the values in Renderer Dictionary.
Declaration
public void Clear()
ContainsKey(String)
Checks whether the Renderer Dictionary contains the corresponding renderer Key.
Declaration
public bool ContainsKey(string key)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | Key to the SpreadsheetCellRenderer Collection. |
Returns
Type | Description |
---|---|
System.Boolean | True if the collection contains the key;otherwise False. |
ContainsValue(ISpreadsheetCellRenderer)
Checks whether the Renderer Dictionary contains the corresponding renderer.
Declaration
public bool ContainsValue(ISpreadsheetCellRenderer cellRenderer)
Parameters
Type | Name | Description |
---|---|---|
ISpreadsheetCellRenderer | cellRenderer | An instance of SpreadsheetCellRendererBase. |
Returns
Type | Description |
---|---|
System.Boolean | True if the collection contains specific value; otherwise false. |
CopyTo(ISpreadsheetCellRenderer[], Int32)
Copies the renderer elements of the System.Collections.ICollection to an System.Array, starting at a particular System.Array index.
Declaration
public void CopyTo(ISpreadsheetCellRenderer[] array, int index)
Parameters
Type | Name | Description |
---|---|---|
ISpreadsheetCellRenderer[] | array | Collection of SpreadsheetCellRendererBase. |
System.Int32 | index | Index of the renderer element. |
CopyTo(Array, Int32)
Copies the elements of the System.Collections.ICollection to an System.Array, starting at a particular System.Array index.
Declaration
public void CopyTo(Array array, int index)
Parameters
Type | Name | Description |
---|---|---|
System.Array | array | The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ICollection. The System.Array must have zero-based indexing. |
System.Int32 | index | The zero-based index in |
Exceptions
Type | Condition |
---|---|
System.ArgumentException |
|
System.ArgumentOutOfRangeException |
|
System.ArgumentNullException |
|
Dispose(Boolean)
Releases the unmanaged resources used by the Component and optionally releases the managed resources.
Declaration
protected override void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | disposing | true to release both managed and unmanaged resources; false to release only unmanaged resources. |
Overrides
Remarks
See the documentation for the System.ComponentModel class and its Dispose member.
GetEnumerator()
Returns the Enumerator that iterates through collection for retriving the values.
Declaration
public IEnumerator GetEnumerator()
Returns
Type | Description |
---|---|
System.Collections.IEnumerator | Content of the SpreadsheetCellRenderer collection |
Remove(String)
Remove the Renderer from dictionary for corresponding key value.
Declaration
public void Remove(string key)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | Key to the SpreadsheetCellRenderer Collection. |