ClassCompositeFilterDescriptor
Represents a filter descriptor that combines multiple filter conditions.
Definition
Namespace:Telerik.WinControls.Data
Assembly:Telerik.WinControls.dll
Syntax:
public class CompositeFilterDescriptor : FilterDescriptor, INotifyPropertyChanged, INotifyPropertyChangingEx, ICloneable
Inheritance: objectFilterDescriptorCompositeFilterDescriptor
Derived Classes:
Implements:
Inherited Members
Constructors
CompositeFilterDescriptor()
Declaration
public CompositeFilterDescriptor()
Properties
Expression
Gets the filter expression.
Declaration
public override string Expression { get; }
Property Value
The filter expression.
Overrides
FilterDescriptors
Gets the filter descriptors.
Declaration
[Browsable(true)]
public virtual FilterDescriptorCollection FilterDescriptors { get; }
Property Value
The filter descriptors.
IsSameName
Gets a value indicating whether this instance contains FilterDescriptor's with different PropertyName.
Declaration
public bool IsSameName { get; }
Property Value
true if any child filters have the same name; otherwise false.
LogicalOperator
Gets or sets the logical operator.
Declaration
[Browsable(true)]
public virtual FilterLogicalOperator LogicalOperator { get; set; }
Property Value
The logical operator.
NotOperator
Gets or sets a value indicating whether [not operator].
Declaration
public bool NotOperator { get; set; }
Property Value
true if [not operator]; otherwise, false.
Operator
Gets or sets the operator.
Declaration
public override FilterOperator Operator { get; set; }
Property Value
The operator.
Overrides
PropertyName
Gets or sets the name of the property.
Declaration
public override string PropertyName { get; set; }
Property Value
The name of the property.
Overrides
Methods
Clone()
Creates a deep copy of the current CompositeFilterDescriptor instance.
Declaration
public override object Clone()
Returns
A new instance of CompositeFilterDescriptor that is a copy of the current instance.
Overrides
ConvertTo(DescriptorType)
Converts to the filter descriptor to concrete type
Declaration
public CompositeFilterDescriptor ConvertTo(CompositeFilterDescriptor.DescriptorType type)
Parameters
type
CompositeFilterDescriptor.DescriptorType
The type.
Returns
The converted instance of CompositeFilterDescriptor
ConvertTo(DescriptorType, Type)
Converts to the filter descriptor to a concrete type.
Declaration
public CompositeFilterDescriptor ConvertTo(CompositeFilterDescriptor.DescriptorType type, Type dataType)
Parameters
type
CompositeFilterDescriptor.DescriptorType
The type to which the filter will be converted.
dataType
The type of data that will be filtered.
Returns
The converted instance of CompositeFilterDescriptor
CreateDescriptor(DescriptorType, string, Type, params object[])
Creates the descriptor.
Declaration
public static CompositeFilterDescriptor CreateDescriptor(CompositeFilterDescriptor.DescriptorType type, string propertyName, Type dataType, params object[] values)
Parameters
type
CompositeFilterDescriptor.DescriptorType
The type.
propertyName
Name of the property.
dataType
Type of the data that will be filtered.
values
object[]
The values.
Returns
CreateDescriptor(DescriptorType, string, params object[])
Creates the descriptor.
Declaration
public static CompositeFilterDescriptor CreateDescriptor(CompositeFilterDescriptor.DescriptorType type, string propertyName, params object[] values)
Parameters
type
CompositeFilterDescriptor.DescriptorType
The type.
propertyName
values
object[]
Returns
GetCompositeExpression(CompositeFilterDescriptor)
Retrieves the composite expression associated with the specified CompositeFilterDescriptor.
Declaration
public static string GetCompositeExpression(CompositeFilterDescriptor filterDescriptor)
Parameters
filterDescriptor
The CompositeFilterDescriptor from which to retrieve the composite expression.
Returns
A string representation of the composite expression for the specified filter descriptor.
GetCompositeExpression(CompositeFilterDescriptor, Function<FilterDescriptor, object>)
Retrieves the composite expression for the specified composite filter descriptor using the provided function to evaluate filter descriptors.
Declaration
public static string GetCompositeExpression(CompositeFilterDescriptor filterDescriptor, Function<FilterDescriptor, object> formatValue)
Parameters
filterDescriptor
The composite filter descriptor to evaluate.
formatValue
Function<FilterDescriptor, object>
The function used to process each filter descriptor.
Returns
A composite expression that represents the evaluation of the filter descriptors.
GetDescriptorType(CompositeFilterDescriptor)
Gets the type of the CompositeFilterDescriptor.
Declaration
public static CompositeFilterDescriptor.DescriptorType GetDescriptorType(CompositeFilterDescriptor compositeDescriptor)
Parameters
compositeDescriptor
The filter descriptor.
Returns
ToString()
Returns a string that represents this instance.