Class GridRowHiddenCollection
Implements a collection of GridRowHidden items with information about row hidden state.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Windows.Forms.Grid
Assembly: Syncfusion.Grid.Windows.dll
Syntax
public class GridRowHiddenCollection : IDisposable, IList, ICollection, IEnumerable
Properties
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 fixed size. Returns 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 GridRowHidden this[int index] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index |
Property Value
Type |
---|
GridRowHidden |
Methods
Add(GridRowHidden)
Adds an object to the collection.
Declaration
public int Add(GridRowHidden value)
Parameters
Type | Name | Description |
---|---|---|
GridRowHidden | 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. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | if |
AddRange(GridRowHidden[])
Adds multiple GridRowHidden items.
Declaration
public void AddRange(GridRowHidden[] rowHiddens)
Parameters
Type | Name | Description |
---|---|---|
GridRowHidden[] | rowHiddens | 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(GridRowHidden)
Determines if the element belongs to this collection.
Declaration
public bool Contains(GridRowHidden value)
Parameters
Type | Name | Description |
---|---|---|
GridRowHidden | 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(GridRowHidden[], Int32)
Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array.
Declaration
public void CopyTo(GridRowHidden[] array, int index)
Parameters
Type | Name | Description |
---|---|---|
GridRowHidden[] | 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 an 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. |
Overrides
GetEnumerator()
Returns an enumerator for the entire collection.
Declaration
public GridRowHiddenCollectionEnumerator GetEnumerator()
Returns
Type | Description |
---|---|
GridRowHiddenCollectionEnumerator | 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. |
Overrides
IndexOf(GridRowHidden)
Returns the zero-based index of the occurrence of the element in the collection.
Declaration
public int IndexOf(GridRowHidden value)
Parameters
Type | Name | Description |
---|---|---|
GridRowHidden | 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, GridRowHidden)
Inserts a GridRowHidden element into the collection at the specified index.
Declaration
public void Insert(int index, GridRowHidden value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The zero-based index at which the element should be inserted. |
GridRowHidden | value | The element to insert. The value must not be a NULL reference (Nothing in Visual Basic). |
Remove(GridRowHidden)
Removes the specified GridRowHidden element from the collection.
Declaration
public void Remove(GridRowHidden value)
Parameters
Type | Name | Description |
---|---|---|
GridRowHidden | value | The GridRowHidden 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. |
Overrides
Explicit Interface Implementations
ICollection.CopyTo(Array, Int32)
Copies the elements of the System.Collections.ICollection to an System.Array, starting at a particular System.Array index.
Declaration
void ICollection.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. |
ICollection.SyncRoot
Gets an object that can be used to synchronize access to the System.Collections.ICollection.
Declaration
object ICollection.SyncRoot { get; }
Returns
Type |
---|
System.Object |
IEnumerable.GetEnumerator()
Returns an enumerator that iterates through a collection.
Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type | Description |
---|---|
System.Collections.IEnumerator | An System.Collections.IEnumerator object that can be used to iterate through the collection. |
IList.Add(Object)
Adds an item to the System.Collections.IList.
Declaration
int IList.Add(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The object to add to the System.Collections.IList. |
Returns
Type | Description |
---|---|
System.Int32 | The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection. |
IList.Contains(Object)
Determines whether the System.Collections.IList contains a specific value.
Declaration
bool IList.Contains(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The object to locate in the System.Collections.IList. |
Returns
Type | Description |
---|---|
System.Boolean | true if the System.Object is found in the System.Collections.IList; otherwise false. |
IList.get_Item(Int32)
Declaration
object IList.get_Item(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index |
Returns
Type |
---|
System.Object |
IList.IndexOf(Object)
Determines the index of a specific item in the System.Collections.IList.
Declaration
int IList.IndexOf(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The object to locate in the System.Collections.IList. |
Returns
Type | Description |
---|---|
System.Int32 | The index of value if found in the list; otherwise, -1. |
IList.Insert(Int32, Object)
Inserts an item to the System.Collections.IList at the specified index.
Declaration
void IList.Insert(int index, object value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The zero-based index at which value should be inserted. |
System.Object | value | The object to insert into the System.Collections.IList. |
IList.Item[Int32]
Gets or sets the element at the specified index.
Declaration
object IList.this[] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The zero-based index of the element to get or set. |
Returns
Type | Description |
---|---|
System.Object | The element at the specified index. |
IList.Remove(Object)
Removes the first occurrence of a specific object from the System.Collections.IList.
Declaration
void IList.Remove(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The object to remove from the System.Collections.IList. |
IList.set_Item(Int32, Object)
Declaration
void IList.set_Item(int index, object value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | |
System.Object | value |