Class TreeGridCellRendererCollection

Represents a collection of objects in the view.

Inheritance

System.Object

NonFinalizeDisposable

Disposable

TreeGridCellRendererCollection

Implements

System.IDisposable

System.Collections.ICollection

System.Collections.IEnumerable

Inherited Members

Disposable.Finalize()

NonFinalizeDisposable.Dispose()

Namespace: Syncfusion.UI.Xaml.TreeGrid.Cells

Assembly: Syncfusion.SfGrid.WPF.dll

Syntax

public class TreeGridCellRendererCollection : Disposable, IDisposable, ICollection, IEnumerable

Remarks

On the TreeGridColumns, you access the through the CellRenderers property.

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

Constructors

TreeGridCellRendererCollection(SfTreeGrid)

Initializes a new instance of class.

Declaration

public TreeGridCellRendererCollection(SfTreeGrid treeGrid)

Parameters

Type	Name	Description
SfTreeGrid	treeGrid	The SfTreeGrid

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 ITreeGridCellRenderer this[string key] { get; set; }

Parameters

Type	Name	Description
System.String	key	The key value.

Property Value

Type	Description
ITreeGridCellRenderer	Returns corresponding renderer.

Keys

Get the Key values of Renderers.

Declaration

public ICollection Keys { get; }

Property Value

Type	Description
System.Collections.ICollection	Returns the keys of the cellrenderer dictionary.

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 Renderers in the collection

Declaration

public ICollection Values { get; }

Property Value

Type	Description
System.Collections.ICollection	Returns the value of the cellrenderer dictionary.

Methods

Add(String, ITreeGridCellRenderer)

Add the Renderer to the Renderer dictionary.

Declaration

public void Add(string key, ITreeGridCellRenderer renderer)

Parameters

Type	Name	Description
System.String	key	Specifies the key value of corresponding renderer.
ITreeGridCellRenderer	renderer	The CellRenderer

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 key value of corresponding renderer.

Returns

Type	Description
System.Boolean	True if Renderer dictionary contains the key; otherwise False

ContainsValue(TreeGridCellRendererBase)

Checks whether the Render Dictionary contains the corresponding renderer.

Declaration

public bool ContainsValue(TreeGridCellRendererBase cellRenderer)

Parameters

Type	Name	Description
TreeGridCellRendererBase	cellRenderer	The Cellrenderer

Returns

Type	Description
System.Boolean	True if Renderer dictionary contains the Cellrenderer; otherwise False

CopyTo(TreeGridCellRendererBase[], Int32)

Copy the Renderer values to Array.

Declaration

public void CopyTo(TreeGridCellRendererBase[] array, int index)

Parameters

Type	Name	Description
TreeGridCellRendererBase[]	array	Array of CellRenderer
System.Int32	index	The CellRendererIndex

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

NonFinalizeDisposable.Dispose(Boolean)

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 key value of corresponding renderer.

Implements

System.IDisposable

System.Collections.ICollection

System.Collections.IEnumerable