Class RecordFilterDescriptorCollection

Represents a class for collection of RecordFilterDescriptor with filter criteria for displaying only a subset of records from the underlying datasource. An instance of this collection is returned by the RecordFilters property of a TableDescriptor.

Inheritance

System.Object

RecordFilterDescriptorCollection

Implements

System.IDisposable

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

IInsideCollectionEditorProperty

System.ICloneable

System.ComponentModel.ICustomTypeDescriptor

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Syncfusion.Grouping

Assembly: Syncfusion.Grouping.Base.dll

Syntax

public class RecordFilterDescriptorCollection : IDisposable, IList, ICollection, IEnumerable, IInsideCollectionEditorProperty, ICloneable, ICustomTypeDescriptor

Constructors

RecordFilterDescriptorCollection()

Initializes a new empty collection.

Declaration

public RecordFilterDescriptorCollection()

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 a value indicating whether the collection is manipulated inside a collection editor or not.

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

Parameters

Type	Name	Description
System.Int32	index

Property Value

Type
RecordFilterDescriptor

Item[String]

Gets or sets the element with the specified name.

Declaration

public RecordFilterDescriptor this[string name] { get; set; }

Parameters

Type	Name	Description
System.String	name

Property Value

Type
RecordFilterDescriptor

LogicalOperator

Gets or sets the logical operator.

Declaration

public FilterLogicalOperator LogicalOperator { get; set; }

Property Value

Type
FilterLogicalOperator

TableDescriptor

The TableDescriptor that this collection belongs to.

Declaration

public TableDescriptor TableDescriptor { get; set; }

Property Value

Type
TableDescriptor

Version

The version number of this collection. The version is increased each time the collection or an element within the collection was modified.

Declaration

public int Version { get; }

Property Value

Type
System.Int32

Methods

Add(RecordFilterDescriptor)

Adds a filter descriptor to the end of the collection.

Declaration

public int Add(RecordFilterDescriptor value)

Parameters

Type	Name	Description
RecordFilterDescriptor	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(String)

Creates a RecordFilterDescriptor based on the specified expression and adds it to the end of the collection.

Declaration

public int Add(string expression)

Parameters

Type	Name	Description
System.String	expression	The filter expression. See the Grid User's Guide for valid expressions.

Returns

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

Add(String, FilterCompareOperator, Object)

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

Declaration

public int Add(string name, FilterCompareOperator compareOperator, object compareValue)

Parameters

Type	Name	Description
System.String	name	The name of the filter.
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.

Clear()

Removes all elements from the collection.

Declaration

public void Clear()

Clone()

Creates a copy of the collection and all its elements.

Declaration

public RecordFilterDescriptorCollection Clone()

Returns

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

CompareRecord(Record)

Evaluates all filters for the given record and returns True if the record meets the filter's criteria.

Declaration

public bool CompareRecord(Record record)

Parameters

Type	Name	Description
Record	record	The record to be evaluated.

Returns

Type	Description
System.Boolean	True if the record meets the filter's criteria; False otherwise.

CompareRecordFilterBar(Record, FieldDescriptor)

Evaluates all filters for the given record and returns True if the record meets the filter's criteria.

Declaration

public bool CompareRecordFilterBar(Record record, FieldDescriptor filterBarFieldDescriptor)

Parameters

Type	Name	Description
Record	record	The record to be evaluated.
FieldDescriptor	filterBarFieldDescriptor	The FieldDescriptor of the Field in a FilterBar

Returns

Type	Description
System.Boolean	True if the record meets the filter's criteria; False otherwise.

Contains(RecordFilterDescriptor)

Determines if the element belongs to this collection.

Declaration

public bool Contains(RecordFilterDescriptor value)

Parameters

Type	Name	Description
RecordFilterDescriptor	value	The element 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.

Contains(String)

Determines if the element with the specified name belongs to this collection.

Declaration

public bool Contains(string name)

Parameters

Type	Name	Description
System.String	name	The name of the element to locate in the collection.

Returns

Type	Description
System.Boolean	True if item is found in the collection; otherwise, False.

CopyTo(RecordFilterDescriptor[], Int32)

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

Declaration

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

Parameters

Type	Name	Description
RecordFilterDescriptor[]	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 if the specified object is equivalent to current object.

Declaration

public override bool Equals(object obj)

Parameters

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

Returns

Type	Description
System.Boolean	True if both the objects are equal; False otherwise.

Overrides

System.Object.Equals(System.Object)

GetEnumerator()

Returns an enumerator for the entire collection.

Declaration

public RecordFilterDescriptorCollectionEnumerator GetEnumerator()

Returns

Type	Description
RecordFilterDescriptorCollectionEnumerator	An Enumerator 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.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	Hash code for the current object.

Overrides

System.Object.GetHashCode()

GetRecordFilters(String)

Gets the collection of RecordFilterDescriptor with the specified mapping name.

Declaration

public RecordFilterDescriptor[] GetRecordFilters(string mappingName)

Parameters

Type	Name	Description
System.String	mappingName	The MappingName of the elements to get.

Returns

Type	Description
RecordFilterDescriptor[]	Array of RecordFilterDescriptor with the specified mapping name.

IndexOf(RecordFilterDescriptor)

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

Declaration

public int IndexOf(RecordFilterDescriptor value)

Parameters

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

IndexOf(String)

Searches for the element with the specified name.

Declaration

public int IndexOf(string name)

Parameters

Type	Name	Description
System.String	name	The name of the element to locate in the collection.

Returns

Type	Description
System.Int32	The zero-based index of the occurrence of the element with matching name within the entire collection, if found; otherwise, -1.

InitializeFrom(RecordFilterDescriptorCollection)

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

Declaration

public void InitializeFrom(RecordFilterDescriptorCollection other)

Parameters

Type	Name	Description
RecordFilterDescriptorCollection	other	The source collection.

Insert(Int32, RecordFilterDescriptor)

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

Declaration

public void Insert(int index, RecordFilterDescriptor value)

Parameters

Type	Name	Description
System.Int32	index	The zero-based index at which the element should be inserted.
RecordFilterDescriptor	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 Changed event.

Declaration

protected virtual void OnChanging(ListPropertyChangedEventArgs e)

Parameters

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

OnPropertyChanged(DescriptorPropertyChangedEventArgs)

Raises the PropertyChanged event.

Declaration

protected virtual void OnPropertyChanged(DescriptorPropertyChangedEventArgs e)

Parameters

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

OnPropertyChanging(DescriptorPropertyChangedEventArgs)

Raises the PropertyChanging event.

Declaration

protected virtual void OnPropertyChanging(DescriptorPropertyChangedEventArgs e)

Parameters

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

Remove(RecordFilterDescriptor)

Removes the specified descriptor element from the collection.

Declaration

public void Remove(RecordFilterDescriptor value)

Parameters

Type	Name	Description
RecordFilterDescriptor	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(String)

Removes the specified descriptor element with the specified name from the collection.

Declaration

public void Remove(string name)

Parameters

Type	Name	Description
System.String	name	The name of the element to remove from the collection. If no element with that name is found 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 holding the current object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	String representation of the current object.

Overrides

System.Object.ToString()

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

PropertyChanged

Occurs when a property is changed.

Declaration

public event DescriptorPropertyChangedEventHandler PropertyChanged

Event Type

Type
DescriptorPropertyChangedEventHandler

PropertyChanging

Occurs before a property is changed.

Declaration

public event DescriptorPropertyChangedEventHandler PropertyChanging

Event Type

Type
DescriptorPropertyChangedEventHandler

Explicit Interface Implementations

IInsideCollectionEditorProperty.InitializeFrom(Object)

Declaration

void IInsideCollectionEditorProperty.InitializeFrom(object other)

Parameters

Type	Name	Description
System.Object	other

ICollection.CopyTo(Array, Int32)

Declaration

void ICollection.CopyTo(Array array, int index)

Parameters

Type	Name	Description
System.Array	array
System.Int32	index

ICollection.SyncRoot

Declaration

object ICollection.SyncRoot { get; }

Returns

Type
System.Object

IEnumerable.GetEnumerator()

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

Type
System.Collections.IEnumerator

IList.Add(Object)

Declaration

int IList.Add(object value)

Parameters

Type	Name	Description
System.Object	value

Returns

Type
System.Int32

IList.Contains(Object)

Declaration

bool IList.Contains(object value)

Parameters

Type	Name	Description
System.Object	value

Returns

Type
System.Boolean

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)

Declaration

int IList.IndexOf(object value)

Parameters

Type	Name	Description
System.Object	value

Returns

Type
System.Int32

IList.Insert(Int32, Object)

Declaration

void IList.Insert(int index, object value)

Parameters

Type	Name	Description
System.Int32	index
System.Object	value

IList.Item[Int32]

Declaration

object IList.this[] { get; set; }

Parameters

Type	Name	Description
System.Int32	index

Returns

Type
System.Object

IList.Remove(Object)

Declaration

void IList.Remove(object value)

Parameters

Type	Name	Description
System.Object	value

IList.set_Item(Int32, Object)

Declaration

void IList.set_Item(int index, object value)

Parameters

Type	Name	Description
System.Int32	index
System.Object	value

ICloneable.Clone()

Declaration

object ICloneable.Clone()

Returns

Type
System.Object

Implements

System.IDisposable

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

IInsideCollectionEditorProperty

System.ICloneable

System.ComponentModel.ICustomTypeDescriptor