Class GridCellRendererCollection
Represents the class that contains the cell renderer collection.
Implements
Inherited Members
Namespace: Syncfusion.WinForms.DataGrid.Renderers
Assembly: Syncfusion.SfDataGrid.WinForms.dll
Syntax
public class GridCellRendererCollection : Disposable, IDisposable, ICollection, IEnumerable
Constructors
GridCellRendererCollection(TableControl)
Initializes a new instance of the GridCellRendererCollection class.
Declaration
public GridCellRendererCollection(TableControl tableControl)
Parameters
Type | Name | Description |
---|---|---|
TableControl | tableControl | The TableControl that belongs to the cell renderer collection. |
Properties
Count
Gets a value indicates a items count of the GridCellRendererCollection items.
Declaration
public int Count { get; }
Property Value
Type |
---|
System.Int32 |
IsSynchronized
Gets a value indicating whether the collection is synchronized.
Declaration
public bool IsSynchronized { get; }
Property Value
Type |
---|
System.Boolean |
Item[String]
Gets or sets the renderer for the given key value.
Declaration
public IGridCellRenderer<TableControl> this[string key] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
System.String | key | The key value that need to retrieve from the collection. |
Property Value
Type | Description |
---|---|
IGridCellRenderer<TableControl> | Return the cell renderer for the given key value. |
SyncRoot
Gets an object that can be used to synchronize access to the collection.
Declaration
public object SyncRoot { get; }
Property Value
Type |
---|
System.Object |
Methods
Add(String, IGridCellRenderer<TableControl>)
Adding the given renderer to the collection.
Declaration
public void Add(string key, IGridCellRenderer<TableControl> renderer)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | The key that used to retrieve the value of the renderer. |
IGridCellRenderer<TableControl> | renderer | The IGridCellRenderer<T> that needs to be added to the collection. |
Clear()
Clears the GridCellRendererCollection.
Declaration
public void Clear()
ContainsKey(String)
Checks whether the given key is exist in the collection.
Declaration
public bool ContainsKey(string key)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | The key that need to be checked. |
Returns
Type | Description |
---|---|
System.Boolean | Returns true when the key is exist; Otherwise returns false. |
CopyTo(IGridCellRenderer<TableControl>[], Int32)
Copies the elements of the CellRenderer collection to the array.
Declaration
public void CopyTo(IGridCellRenderer<TableControl>[] array, int index)
Parameters
Type | Name | Description |
---|---|---|
IGridCellRenderer<TableControl>[] | array | The cell renderer array that needs to copy the elements of the collection. |
System.Int32 | index | The start index that need to be copied from. |
CopyTo(Array, Int32)
Copies the elements of the CellRenderer collection to the array.
Declaration
public void CopyTo(Array array, int index)
Parameters
Type | Name | Description |
---|---|---|
System.Array | array | The array that needs to copy the elements of the collection. |
System.Int32 | index | The start index that need to be copied from. |
Dispose(Boolean)
Overridden to clear the unused resource of the GridCellRendererCollection class.
Declaration
protected override void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | disposing | Specifies the value whether to release both the managed and unmanaged resources or only the unmanaged resource. |
Overrides
GetEnumerator()
Gets the System.Collections.IEnumerator of the collection.
Declaration
public IEnumerator GetEnumerator()
Returns
Type | Description |
---|---|
System.Collections.IEnumerator | Returns the System.Collections.IEnumerator of the collection. |
Remove(String)
Removes the renderer from the collection.
Declaration
public void Remove(string key)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | The key of the renderer that need to be removed. |