Class
CompositeFilterDescriptor

Represents a filter descriptor that combines multiple filter conditions.

Definition

Namespace:Telerik.WinControls.Data

Assembly:Telerik.WinControls.dll

Syntax:

cs-api-definition
public class CompositeFilterDescriptor : FilterDescriptor, INotifyPropertyChanged, INotifyPropertyChangingEx, ICloneable

Inheritance: objectFilterDescriptorCompositeFilterDescriptor

Derived Classes: FilterExpressionRadCompositeValidationRule

Implements: ICloneableINotifyPropertyChangedINotifyPropertyChangingEx

Inherited Members FilterDescriptor.GetExpression(FilterDescriptor, Function<FilterDescriptor, object>)FilterDescriptor.GetExpression(FilterDescriptor)FilterDescriptor.OnPropertyChanged(string)FilterDescriptor.OnPropertyChanged(PropertyChangedEventArgs)FilterDescriptor.OnPropertyChanging(string, object, object)FilterDescriptor.OnPropertyChanging(PropertyChangingEventArgsEx)FilterDescriptor.ValueFilterDescriptor.IsFilterEditorFilterDescriptor.PropertyChangedFilterDescriptor.PropertyChanging

Constructors

CompositeFilterDescriptor()

Declaration

cs-api-definition
public CompositeFilterDescriptor()

Properties

Expression

Gets the filter expression.

Declaration

cs-api-definition
public override string Expression { get; }

Property Value

string

The filter expression.

Overrides FilterDescriptor.Expression

FilterDescriptors

Gets the filter descriptors.

Declaration

cs-api-definition
[Browsable(true)]
public virtual FilterDescriptorCollection FilterDescriptors { get; }

Property Value

FilterDescriptorCollection

The filter descriptors.

IsSameName

Gets a value indicating whether this instance contains FilterDescriptor's with different PropertyName.

Declaration

cs-api-definition
public bool IsSameName { get; }

Property Value

bool

true if any child filters have the same name; otherwise false.

LogicalOperator

Gets or sets the logical operator.

Declaration

cs-api-definition
[Browsable(true)]
public virtual FilterLogicalOperator LogicalOperator { get; set; }

Property Value

FilterLogicalOperator

The logical operator.

NotOperator

Gets or sets a value indicating whether [not operator].

Declaration

cs-api-definition
public bool NotOperator { get; set; }

Property Value

bool

true if [not operator]; otherwise, false.

Operator

Gets or sets the operator.

Declaration

cs-api-definition
public override FilterOperator Operator { get; set; }

Property Value

FilterOperator

The operator.

Overrides FilterDescriptor.Operator

PropertyName

Gets or sets the name of the property.

Declaration

cs-api-definition
public override string PropertyName { get; set; }

Property Value

string

The name of the property.

Overrides FilterDescriptor.PropertyName

Methods

Clone()

Creates a deep copy of the current CompositeFilterDescriptor instance.

Declaration

cs-api-definition
public override object Clone()

Returns

object

A new instance of CompositeFilterDescriptor that is a copy of the current instance.

Overrides FilterDescriptor.Clone()

ConvertTo(DescriptorType)

Converts to the filter descriptor to concrete type

Declaration

cs-api-definition
public CompositeFilterDescriptor ConvertTo(CompositeFilterDescriptor.DescriptorType type)

Parameters

type

CompositeFilterDescriptor.DescriptorType

The type.

Returns

CompositeFilterDescriptor

The converted instance of CompositeFilterDescriptor

ConvertTo(DescriptorType, Type)

Converts to the filter descriptor to a concrete type.

Declaration

cs-api-definition
public CompositeFilterDescriptor ConvertTo(CompositeFilterDescriptor.DescriptorType type, Type dataType)

Parameters

type

CompositeFilterDescriptor.DescriptorType

The type to which the filter will be converted.

dataType

Type

The type of data that will be filtered.

Returns

CompositeFilterDescriptor

The converted instance of CompositeFilterDescriptor

CreateDescriptor(DescriptorType, string, Type, params object[])

Creates the descriptor.

Declaration

cs-api-definition
public static CompositeFilterDescriptor CreateDescriptor(CompositeFilterDescriptor.DescriptorType type, string propertyName, Type dataType, params object[] values)

Parameters

type

CompositeFilterDescriptor.DescriptorType

The type.

propertyName

string

Name of the property.

dataType

Type

Type of the data that will be filtered.

values

object[]

The values.

Returns

CompositeFilterDescriptor

CreateDescriptor(DescriptorType, string, params object[])

Creates the descriptor.

Declaration

cs-api-definition
public static CompositeFilterDescriptor CreateDescriptor(CompositeFilterDescriptor.DescriptorType type, string propertyName, params object[] values)

Parameters

type

CompositeFilterDescriptor.DescriptorType

The type.

propertyName

string

values

object[]

Returns

CompositeFilterDescriptor

GetCompositeExpression(CompositeFilterDescriptor)

Retrieves the composite expression associated with the specified CompositeFilterDescriptor.

Declaration

cs-api-definition
public static string GetCompositeExpression(CompositeFilterDescriptor filterDescriptor)

Parameters

filterDescriptor

CompositeFilterDescriptor

The CompositeFilterDescriptor from which to retrieve the composite expression.

Returns

string

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

cs-api-definition
public static string GetCompositeExpression(CompositeFilterDescriptor filterDescriptor, Function<FilterDescriptor, object> formatValue)

Parameters

filterDescriptor

CompositeFilterDescriptor

The composite filter descriptor to evaluate.

formatValue

Function<FilterDescriptor, object>

The function used to process each filter descriptor.

Returns

string

A composite expression that represents the evaluation of the filter descriptors.

GetDescriptorType(CompositeFilterDescriptor)

Gets the type of the CompositeFilterDescriptor.

Declaration

cs-api-definition
public static CompositeFilterDescriptor.DescriptorType GetDescriptorType(CompositeFilterDescriptor compositeDescriptor)

Parameters

compositeDescriptor

CompositeFilterDescriptor

The filter descriptor.

Returns

CompositeFilterDescriptor.DescriptorType

ToString()

Returns a string that represents this instance.

Declaration

cs-api-definition
public override string ToString()

Returns

string

A string that represents this instance.

Overrides FilterDescriptor.ToString()