Class GridColHiddenCollection
Implements a collection of GridColHidden items with information about column hidden state.
Inheritance
Implements
Namespace: Syncfusion.Windows.Forms.Grid
Assembly: Syncfusion.Grid.Windows.dll
Syntax
public class GridColHiddenCollection : Object, IDisposable, IList, ICollection, IEnumerableProperties
Count
Gets the number of elements contained in the collection.
Declaration
public int Count { get; }Property Value
| Type |
|---|
| System.Int32 |
IsFixedSize
Gets a value indicating whether collection has no fixed size. Normally false since this collection has no fixed size. Only when it is Read-only IsFixedHide returns True.
Declaration
public bool IsFixedSize { get; }Property Value
| Type |
|---|
| System.Boolean |
IsReadOnly
Gets a value indicating whether the collection is Read-only.
Declaration
public bool IsReadOnly { get; }Property Value
| Type |
|---|
| System.Boolean |
IsSynchronized
Gets a value indicating whether is Synchronized. Returns false.
Declaration
public bool IsSynchronized { get; }Property Value
| Type |
|---|
| System.Boolean |
Item[Int32]
Gets or sets the element at the zero-based index.
Declaration
public GridColHidden this[int index] { get; set; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index |
Property Value
| Type |
|---|
| GridColHidden |
Methods
Add(GridColHidden)
Adds an object to the collection.
Declaration
public int Add(GridColHidden value)Parameters
| Type | Name | Description |
|---|---|---|
| GridColHidden | value | The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic). |
Returns
| Type | Description |
|---|---|
| System.Int32 | The new Count. |
AddRange(GridColHidden[])
Adds multiple GridColHidden items.
Declaration
public void AddRange(GridColHidden[] colHiddens)Parameters
| Type | Name | Description |
|---|---|---|
| GridColHidden[] | colHiddens | The Array with elements that should be added to the end of the collection. The array and its elements cannot be NULL references (Nothing in Visual Basic). |
Clear()
Removes all elements from the collection.
Declaration
public void Clear()Contains(GridColHidden)
Determines if the element belongs to this collection.
Declaration
public bool Contains(GridColHidden value)Parameters
| Type | Name | Description |
|---|---|---|
| GridColHidden | value | The Object to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic). |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if item is found in the collection; otherwise, False. |
CopyTo(GridColHidden[], Int32)
Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array.
Declaration
public void CopyTo(GridColHidden[] array, int index)Parameters
| Type | Name | Description |
|---|---|---|
| GridColHidden[] | array | The one-dimensional Array that is the destination of the elements copied from ArrayList. The Array must have zero-based indexing. |
| System.Int32 | index | The zero-based index in array at which copying begins. |
Dispose()
Disposes the object and collection items.
Declaration
public void Dispose()Equals(Object)
Determines whether the specified System.Object is equal to the current System.Object.
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj | The System.Object to compare with the current System.Object. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if the specified System.Object is equal to the current System.Object; otherwise, false. |
GetEnumerator()
Returns an enumerator for the entire collection
Declaration
public GridColHiddenCollectionEnumerator GetEnumerator()Returns
| Type | Description |
|---|---|
| GridColHiddenCollectionEnumerator | An IEnumerator for the entire collection. |
Remarks
Enumerators only allow reading the data in the collection. Enumerators cannot be used to modify the underlying collection.
GetHashCode()
Serves as a hash function for a particular type.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 | A hash code for the current object. |
IndexOf(GridColHidden)
Returns the zero-based index of the occurrence of the element in the collection.
Declaration
public int IndexOf(GridColHidden value)Parameters
| Type | Name | Description |
|---|---|---|
| GridColHidden | value | The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic). |
Returns
| Type | Description |
|---|---|
| System.Int32 | The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1. |
Insert(Int32, GridColHidden)
Inserts a GridColHidden element into the collection at the specified index.
Declaration
public void Insert(int index, GridColHidden value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The zero-based index at which the element should be inserted. |
| GridColHidden | value | The element to insert. The value must not be a NULL reference (Nothing in Visual Basic). |
Remove(GridColHidden)
Removes the specified GridColHidden element from the collection.
Declaration
public void Remove(GridColHidden value)Parameters
| Type | Name | Description |
|---|---|---|
| GridColHidden | value | The GridColHidden to remove from the collection. If the value is NULL or the element is not contained in the collection the method will do nothing. |
RemoveAt(Int32)
Removes the element at the specified index of the collection.
Declaration
public void RemoveAt(int index)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The zero-based index of the element to remove. |
ToString()
Returns a string that represents the current object.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| System.String | A string that represents the current object. |