New to Telerik UI for WinFormsStart a free 30-day trial

Represents a filter descriptor that combines multiple filter conditions.

Definition

Constructors

C#
public CompositeFilterDescriptor()

Properties

Gets the filter expression.

C#
public override string Expression { get; }
Property Value:

The filter expression.

Overrides: FilterDescriptor.Expression

Gets the filter descriptors.

C#
[Browsable(true)]
public virtual FilterDescriptorCollection FilterDescriptors { get; }
Property Value:

The filter descriptors.

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

C#
public bool IsSameName { get; }
Property Value:

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

Gets or sets the logical operator.

C#
[Browsable(true)]
public virtual FilterLogicalOperator LogicalOperator { get; set; }
Property Value:

The logical operator.

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

C#
public bool NotOperator { get; set; }
Property Value:

true if [not operator]; otherwise, false.

Gets or sets the operator.

C#
public override FilterOperator Operator { get; set; }
Property Value:

The operator.

Overrides: FilterDescriptor.Operator

Gets or sets the name of the property.

C#
public override string PropertyName { get; set; }
Property Value:

The name of the property.

Overrides: FilterDescriptor.PropertyName

Methods

Creates a deep copy of the current CompositeFilterDescriptor instance.

C#
public override object Clone()
Returns:

object

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

Overrides: FilterDescriptor.Clone()

Converts to the filter descriptor to a concrete type.

C#
public CompositeFilterDescriptor ConvertTo(CompositeFilterDescriptor.DescriptorType type, Type dataType)
Parameters:typeCompositeFilterDescriptor.DescriptorType

The type to which the filter will be converted.

dataTypeType

The type of data that will be filtered.

Returns:

CompositeFilterDescriptor

The converted instance of CompositeFilterDescriptor

Converts to the filter descriptor to concrete type

C#
public CompositeFilterDescriptor ConvertTo(CompositeFilterDescriptor.DescriptorType type)
Parameters:typeCompositeFilterDescriptor.DescriptorType

The type.

Returns:

CompositeFilterDescriptor

The converted instance of CompositeFilterDescriptor

Creates the descriptor.

C#
public static CompositeFilterDescriptor CreateDescriptor(CompositeFilterDescriptor.DescriptorType type, string propertyName, params object[] values)
Parameters:typeCompositeFilterDescriptor.DescriptorType

The type.

propertyNamestringvaluesobject[]
Returns:

CompositeFilterDescriptor

Creates the descriptor.

C#
public static CompositeFilterDescriptor CreateDescriptor(CompositeFilterDescriptor.DescriptorType type, string propertyName, Type dataType, params object[] values)
Parameters:typeCompositeFilterDescriptor.DescriptorType

The type.

propertyNamestring

Name of the property.

dataTypeType

Type of the data that will be filtered.

valuesobject[]

The values.

Returns:

CompositeFilterDescriptor

Retrieves the composite expression for the specified composite filter descriptor using the provided function to evaluate filter descriptors.

C#
public static string GetCompositeExpression(CompositeFilterDescriptor filterDescriptor, Function<FilterDescriptor, object> formatValue)
Parameters:filterDescriptorCompositeFilterDescriptor

The composite filter descriptor to evaluate.

formatValueFunction<FilterDescriptor, object>

The function used to process each filter descriptor.

Returns:

string

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

Retrieves the composite expression associated with the specified CompositeFilterDescriptor.

C#
public static string GetCompositeExpression(CompositeFilterDescriptor filterDescriptor)
Parameters:filterDescriptorCompositeFilterDescriptor

The CompositeFilterDescriptor from which to retrieve the composite expression.

Returns:

string

A string representation of the composite expression for the specified filter descriptor.

Gets the type of the CompositeFilterDescriptor.

C#
public static CompositeFilterDescriptor.DescriptorType GetDescriptorType(CompositeFilterDescriptor compositeDescriptor)
Parameters:compositeDescriptorCompositeFilterDescriptor

The filter descriptor.

Returns:

CompositeFilterDescriptor.DescriptorType

Returns a string that represents this instance.

C#
public override string ToString()
Returns:

string

A string that represents this instance.

Overrides: FilterDescriptor.ToString()