Class GridCellRendererCollection

Represents a collection of GridCellRendererBase objects in the view.

Inheritance
System.Object
NonFinalizeDisposable
Disposable
GridCellRendererCollection
Implements
System.IDisposable
System.Collections.ICollection
System.Collections.IEnumerable
Inherited Members
Namespace: Syncfusion.UI.Xaml.DataGrid.Renderers
Assembly: Syncfusion.Grid.WinUI.dll
Syntax
public class GridCellRendererCollection : Disposable, IDisposable, ICollection, IEnumerable
Remarks

On the Columns, you access the GridCellRendererCollection through the CellRenderers property.

The GridCellRendererCollection uses standard Add(String, IGridCellRenderer) and Remove(String) methods to manipulate the collection. Use the Contains method to determine if a specific cell type exists in the collection.

Constructors

GridCellRendererCollection(SfDataGrid)

Initializes a new instance of GridCellRendererCollection class.

Declaration
public GridCellRendererCollection(SfDataGrid dataGrid)
Parameters
Type Name Description
SfDataGrid dataGrid

The SfDataGrid.

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]

Indexer will return the corresponding renderer for the corresponding Key value.

Declaration
public IGridCellRenderer this[string key] { get; set; }
Parameters
Type Name Description
System.String key

The key value.
Property Value
Type Description
IGridCellRenderer

Returns corresponding renderer.

Keys

Get the Key values of renderer.

Declaration
public ICollection Keys { get; }
Property Value
Type
System.Collections.ICollection

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 renderer in the collection.

Declaration
public ICollection Values { get; }
Property Value
Type
System.Collections.ICollection

Methods

Add(String, IGridCellRenderer)

Add the Renderer to the Renderer dictionary.

Declaration
public void Add(string key, IGridCellRenderer renderer)
Parameters
Type Name Description
System.String key

Specifies the cell type for columns and its renderers.
IGridCellRenderer renderer

Specifies the renderer.

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

Specifies the cell type for columns and its renderers.
Returns
Type Description
System.Boolean

True if key is available in renderer dictionary; otherwise false.

ContainsValue(GridCellRendererBase)

Cheks whether the render dictionary contains the corresponding renderer.

Declaration
public bool ContainsValue(GridCellRendererBase cellRenderer)
Parameters
Type Name Description
GridCellRendererBase cellRenderer

Specifies the cell renderer
Returns
Type Description
System.Boolean

True if key is available in renderer dictionary; otherwise false.

CopyTo(GridCellRendererBase[], Int32)

Copy the renderer values to Array.

Declaration
public void CopyTo(GridCellRendererBase[] array, int index)
Parameters
Type Name Description
GridCellRendererBase[] array

List of cell renderers.
System.Int32 index

Cell Renderer Index.

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 array at which copying begins.
Exceptions
Type Condition
System.ArgumentException

array is multidimensional.-or- The number of elements in the source System.Collections.ICollection is greater than the available space from index to the end of the destination array.-or-The type of the source System.Collections.ICollection cannot be cast automatically to the type of the destination array.
System.ArgumentOutOfRangeException

index is less than zero.
System.ArgumentNullException

array is null.

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.Component class and its Dispose member.

GetEnumerator()

Returns the enumerator for retrieving the values.

Declaration
public IEnumerator GetEnumerator()
Returns
Type Description
System.Collections.IEnumerator

Returns an enumerator that iterates through the renderer dictionary

Remove(String)

Remove the renderer from dictionary for corresponding key value.

Declaration
public void Remove(string key)
Parameters
Type Name Description
System.String key

Specifies the cell type for columns and its renderers.

Implements

System.IDisposable
System.Collections.ICollection
System.Collections.IEnumerable