Class FilterBarRowCollection
Represents the class that provides a collection of FilterBarRow elements that are children of a FilterBarSection in a Group. An instance of this collection is returned by the FilterBarRows property of a FilterBarSection object. (NOTE: FilterBars are not supported in Version 2.0).
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Grouping
Assembly: Syncfusion.Grouping.Base.dll
Syntax
public class FilterBarRowCollection : 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 the collection is of fixed size or not.
Declaration
public bool IsFixedSize { get; }
Property Value
Type |
---|
System.Boolean |
IsReadOnly
Gets a value indicating whether the collection is read-only or not.
Declaration
public bool IsReadOnly { get; }
Property Value
Type |
---|
System.Boolean |
IsSynchronized
Gets a value indicating whether the object can be used to synchronize access to the collection or not.
Declaration
public bool IsSynchronized { get; }
Property Value
Type |
---|
System.Boolean |
Item[Int32]
Gets or sets the element at the zero-based index.
Declaration
public FilterBarRow this[int index] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index |
Property Value
Type |
---|
FilterBarRow |
Methods
Add(FilterBarRow)
Adds a value to the end of the collection.
Declaration
public int Add(FilterBarRow value)
Parameters
Type | Name | Description |
---|---|---|
FilterBarRow | 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 position into which the new element was inserted, or -1 to indicate that the item is not inserted. |
Clear()
Removes all elements from the collection.
Declaration
public void Clear()
Contains(FilterBarRow)
Determines if the element belongs to this collection or not.
Declaration
public bool Contains(FilterBarRow value)
Parameters
Type | Name | Description |
---|---|---|
FilterBarRow | value | The Object to be located in the collection. The value can be a NULL reference (Nothing in Visual Basic). |
Returns
Type | Description |
---|---|
System.Boolean | True if the item is in the collection;Otherwise False. |
CopyTo(FilterBarRow[], Int32)
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
Declaration
public void CopyTo(FilterBarRow[] array, int index)
Parameters
Type | Name | Description |
---|---|---|
FilterBarRow[] | array | The single-dimensional zero-index based array that stores the items. |
System.Int32 | index | The zero-based index in array at which copying begins. |
GetEnumerator()
Gets an enumerator that iterates through a collection.
Declaration
public FilterBarRowCollectionEnumerator GetEnumerator()
Returns
Type | Description |
---|---|
FilterBarRowCollectionEnumerator | An instance of the FilterBarRowCollectionEnumerator class. |
Remarks
Enumerators only allow reading of the data in the collection. Enumerators cannot be used to modify the underlying collection.
IndexOf(FilterBarRow)
Determines and gets the index of the specific item in the collection.
Declaration
public int IndexOf(FilterBarRow value)
Parameters
Type | Name | Description |
---|---|---|
FilterBarRow | value | The element to be located in the collection. The value can be a NULL reference (Nothing in Visual Basic). |
Returns
Type | Description |
---|---|
System.Int32 | The index of value if found in the list; Otherwise, -1. |
Insert(Int32, FilterBarRow)
Inserts an element into the collection at the specified index.
Declaration
public void Insert(int index, FilterBarRow value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The zero-based index of the item to be added. |
FilterBarRow | value | The element to be inserted. The value must not be a NULL reference (Nothing in Visual Basic). |
Remove(FilterBarRow)
Removes the specified element from the collection.
Declaration
public void Remove(FilterBarRow value)
Parameters
Type | Name | Description |
---|---|---|
FilterBarRow | value | The element to be removed from the collection. |
Remarks
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. |
Explicit Interface Implementations
ICollection.CopyTo(Array, Int32)
Copies the elements of the collection from a specific array index.
Declaration
void ICollection.CopyTo(Array array, int index)
Parameters
Type | Name | Description |
---|---|---|
System.Array | array | The single-dimensional array that stores the items. |
System.Int32 | index | The zero-based array index. |
ICollection.SyncRoot
Gets an object that can be used to synchronize access to the collection.
Declaration
object ICollection.SyncRoot { get; }
Returns
Type |
---|
System.Object |
IEnumerable.GetEnumerator()
Gets an enumerator that iterates through a collection.
Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type | Description |
---|---|
System.Collections.IEnumerator | An instance of the System.Collections.IEnumerator class that can be used to iterate through the collection. |
IList.Add(Object)
Adds the item to the collection.
Declaration
int IList.Add(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The item to be added in the collection. |
Returns
Type | Description |
---|---|
System.Int32 | The position into which the new element was inserted, or -1 to indicate that the item is not inserted. |
IList.Contains(Object)
Determines a value indicating whether the specified item is in the collection or not.
Declaration
bool IList.Contains(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The object to be checked. |
Returns
Type | Description |
---|---|
System.Boolean | True if the item is in the collection;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 and gets the index of the specific item in the collection.
Declaration
int IList.IndexOf(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The item to be located in the collection. |
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 collection at the specified index.
Declaration
void IList.Insert(int index, object value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The zero-based index of the item to be added. |
System.Object | value | The item to be added. |
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. |
Returns
Type | Description |
---|---|
System.Object | The element at the specified index. |
IList.Remove(Object)
Removes the item from the collection.
Declaration
void IList.Remove(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The item to be removed. |
IList.set_Item(Int32, Object)
Declaration
void IList.set_Item(int index, object value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | |
System.Object | value |