Class FilterConditionCollection

Represents a class for collection of FilterCondition that are children of a RecordFilterDescriptor with filter criteria for displaying only a subset of records from the underlying datasource. An instance of this collection is returned by the Conditions property of a RecordFilterDescriptor.

Inheritance

System.Object

FilterConditionCollection

Implements

System.IDisposable

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

System.ICloneable

System.ComponentModel.ICustomTypeDescriptor

Namespace: Syncfusion.Grouping

Assembly: Syncfusion.Grouping.Base.dll

Syntax

public class FilterConditionCollection : Object, IDisposable, IList, ICollection, IEnumerable, ICloneable, ICustomTypeDescriptor

Constructors

FilterConditionCollection()

Initializes a new empty collection.

Declaration

public FilterConditionCollection()

FilterConditionCollection(FilterCondition[])

Used to represents the FilterConditionCollection

Declaration

protected FilterConditionCollection(FilterCondition[] filterDescriptors)

Parameters

Type	Name	Description
FilterCondition[]	filterDescriptors	FilterCondition

Properties

Count

Gets the number of elements contained in the collection.

Declaration

public int Count { get; }

Property Value

Type
System.Int32

InsideCollectionEditor

Gets or sets whether the collection is manipulated inside a collection editor.

Declaration

public bool InsideCollectionEditor { get; set; }

Property Value

Type
System.Boolean

IsFixedSize

Returns False since this collection has no fixed size.

Declaration

public bool IsFixedSize { get; }

Property Value

Type
System.Boolean

IsReadOnly

Returns False.

Declaration

public bool IsReadOnly { get; }

Property Value

Type
System.Boolean

IsSynchronized

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 FilterCondition this[int index] { get; set; }

Parameters

Type	Name	Description
System.Int32	index

Property Value

Type
FilterCondition

Methods

Add(FilterCompareOperator, Object)

Creates a FilterCondition and adds it to the end of the collection.

Declaration

public int Add(FilterCompareOperator compareOperator, object compareValue)

Parameters

Type	Name	Description
FilterCompareOperator	compareOperator	The comparison operator.
System.Object	compareValue	The comparison value.

Returns

Type	Description
System.Int32	The zero-based collection index at which the value has been added.

Add(FilterCondition)

Adds FilterCondition to the end of the collection.

Declaration

public int Add(FilterCondition value)

Parameters

Type	Name	Description
FilterCondition	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 zero-based collection index at which the value has been added.

add_Changed(ListPropertyChangedEventHandler)

Declaration

public void add_Changed(ListPropertyChangedEventHandler value)

Parameters

Type	Name	Description
ListPropertyChangedEventHandler	value

add_Changing(ListPropertyChangedEventHandler)

Declaration

public void add_Changing(ListPropertyChangedEventHandler value)

Parameters

Type	Name	Description
ListPropertyChangedEventHandler	value

Clear()

Removes all elements from the collection.

Declaration

public void Clear()

Clone()

Creates a copy of the collection and all its elements.

Declaration

public virtual FilterConditionCollection Clone()

Returns

Type	Description
FilterConditionCollection	A copy of the collection and all its elements.

Contains(FilterCondition)

Determines if the element belongs to this collection.

Declaration

public bool Contains(FilterCondition value)

Parameters

Type	Name	Description
FilterCondition	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.

CopyAllMembersTo(FilterConditionCollection)

Used to copy all the members

Declaration

protected void CopyAllMembersTo(FilterConditionCollection coll)

Parameters

Type	Name	Description
FilterConditionCollection	coll	FilterConditionCollection

CopyTo(FilterCondition[], Int32)

Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.

Declaration

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

Parameters

Type	Name	Description
FilterCondition[]	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 of the object and collection items.

Declaration

public void Dispose()

Equals(Object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	The object to compare.

Returns

Type	Description
System.Boolean	True if the specified object is equal to the current object; otherwise, false.

GetEnumerator()

Returns an enumerator for the entire collection.

Declaration

public FilterConditionCollectionEnumerator GetEnumerator()

Returns

Type	Description
FilterConditionCollectionEnumerator	An Enumerator for the entire collection.

Remarks

Enumerators only allow reading of 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.

IndexOf(FilterCondition)

Returns the zero-based index of the occurrence of the element in the collection.

Declaration

public int IndexOf(FilterCondition value)

Parameters

Type	Name	Description
FilterCondition	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.

InitializeFrom(FilterConditionCollection)

Copies settings from another collection and raises Changing and Changed events if differences to the other collection are detected.

Declaration

public void InitializeFrom(FilterConditionCollection other)

Parameters

Type	Name	Description
FilterConditionCollection	other	The source collection.

Insert(Int32, FilterCondition)

Inserts a descriptor element into the collection at the specified index.

Declaration

public void Insert(int index, FilterCondition value)

Parameters

Type	Name	Description
System.Int32	index	The zero-based index at which the element should be inserted.
FilterCondition	value	The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).

OnChanged(ListPropertyChangedEventArgs)

Raises the Changed event.

Declaration

protected virtual void OnChanged(ListPropertyChangedEventArgs e)

Parameters

Type	Name	Description
ListPropertyChangedEventArgs	e	A ListPropertyChangedEventArgs that contains the event data.

OnChanging(ListPropertyChangedEventArgs)

Raises the Changing event.

Declaration

protected virtual void OnChanging(ListPropertyChangedEventArgs e)

Parameters

Type	Name	Description
ListPropertyChangedEventArgs	e	A ListPropertyChangedEventArgs that contains the event data.

Remove(FilterCondition)

Removes the specified descriptor element from the collection.

Declaration

public void Remove(FilterCondition value)

Parameters

Type	Name	Description
FilterCondition	value	The element to remove from the collection. If the value is NULL or the element is not contained in the collection, the method will do nothing.

remove_Changed(ListPropertyChangedEventHandler)

Declaration

public void remove_Changed(ListPropertyChangedEventHandler value)

Parameters

Type	Name	Description
ListPropertyChangedEventHandler	value

remove_Changing(ListPropertyChangedEventHandler)

Declaration

public void remove_Changing(ListPropertyChangedEventHandler value)

Parameters

Type	Name	Description
ListPropertyChangedEventHandler	value

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	String representation of the object.

Events

Changed

Occurs after a property in a nested element or the collection is changed.

Declaration

public event ListPropertyChangedEventHandler Changed

Event Type

Type
ListPropertyChangedEventHandler

Changing

Occurs before a property in a nested element or the collection is changed.

Declaration

public event ListPropertyChangedEventHandler Changing

Event Type

Type
ListPropertyChangedEventHandler

Implements

System.IDisposable

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

System.ICloneable

System.ComponentModel.ICustomTypeDescriptor