Class
FilterExpression

Represents a filter expression.

Definition

Namespace:Telerik.WinControls.Data

Assembly:Telerik.WinControls.GridView.dll

Syntax:

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

Inheritance: objectFilterDescriptorCompositeFilterDescriptorFilterExpression

Derived Classes: CompositeFilterExpression

Implements: ICloneableINotifyPropertyChangedINotifyPropertyChangingEx

Inherited Members CompositeFilterDescriptor.GetDescriptorType(CompositeFilterDescriptor)CompositeFilterDescriptor.CreateDescriptor(CompositeFilterDescriptor.DescriptorType, string, params object[])CompositeFilterDescriptor.CreateDescriptor(CompositeFilterDescriptor.DescriptorType, string, Type, params object[])CompositeFilterDescriptor.GetCompositeExpression(CompositeFilterDescriptor)CompositeFilterDescriptor.GetCompositeExpression(CompositeFilterDescriptor, Function<FilterDescriptor, object>)CompositeFilterDescriptor.Clone()CompositeFilterDescriptor.ConvertTo(CompositeFilterDescriptor.DescriptorType)CompositeFilterDescriptor.ConvertTo(CompositeFilterDescriptor.DescriptorType, Type)CompositeFilterDescriptor.LogicalOperatorCompositeFilterDescriptor.FilterDescriptorsCompositeFilterDescriptor.NotOperatorCompositeFilterDescriptor.PropertyNameCompositeFilterDescriptor.OperatorCompositeFilterDescriptor.IsSameNameCompositeFilterDescriptor.ExpressionFilterDescriptor.GetExpression(FilterDescriptor, Function<FilterDescriptor, object>)FilterDescriptor.GetExpression(FilterDescriptor)FilterDescriptor.OnPropertyChanged(string)FilterDescriptor.OnPropertyChanged(PropertyChangedEventArgs)FilterDescriptor.OnPropertyChanging(string, object, object)FilterDescriptor.OnPropertyChanging(PropertyChangingEventArgsEx)FilterDescriptor.ValueFilterDescriptor.PropertyChangedFilterDescriptor.PropertyChanging

Constructors

FilterExpression()

Creates an instance of the FilterExpression class.

Declaration

cs-api-definition
public FilterExpression()

FilterExpression(BinaryOperation, GridKnownFunction, params object[])

Creates an instance of the FilterExpression class with a new FilterPredicate.

Declaration

cs-api-definition
public FilterExpression(FilterExpression.BinaryOperation binaryOperation, GridKnownFunction function, params object[] values)

Parameters

binaryOperation

FilterExpression.BinaryOperation

The binary operation that is used by the new FilterExpression.

function

GridKnownFunction

The GridKnownFunction that is used to create the FilterPredicate object.

values

object[]

The values that are used to create the FilterPredicate object.

FilterExpression(string)

Creates an instance of the FilterExpression class.

Declaration

cs-api-definition
public FilterExpression(string fieldName)

Parameters

fieldName

string

The field name in the context of which the filter string is generated.

FilterExpression(string, BinaryOperation, GridKnownFunction, params object[])

Creates an instance of the FilterExpression class with a new FilterPredicate.

Declaration

cs-api-definition
public FilterExpression(string fieldName, FilterExpression.BinaryOperation binaryOperation, GridKnownFunction function, params object[] values)

Parameters

fieldName

string

The field name in the context of which the filter string is generated.

binaryOperation

FilterExpression.BinaryOperation

The binary operation that is used by the new FilterExpression.

function

GridKnownFunction

The GridKnownFunction that is used to create the FilterPredicate object.

values

object[]

The values that are used to create the FilterPredicate object.

Properties

BinaryOperator

Gets or sets a value that indicates which binary operator will be used when concatenating multiple filter expressions.

Declaration

cs-api-definition
[Browsable(true)]
public FilterExpression.BinaryOperation BinaryOperator { get; set; }

Property Value

FilterExpression.BinaryOperation

FieldName

Gets or sets a value that indicates the name of the associated field.

Declaration

cs-api-definition
[Browsable(true)]
public string FieldName { get; set; }

Property Value

string

IsFilterEditor

Gets a value indicating whether this instance is default filter descriptor of the column

Declaration

cs-api-definition
public override bool IsFilterEditor { get; }

Property Value

bool

true if this instance is default; otherwise, false.

Overrides FilterDescriptor.IsFilterEditor

IsValid

Gets a value indicating whether the filter expression is valid.

Declaration

cs-api-definition
[Browsable(false)]
public bool IsValid { get; }

Property Value

bool

Parameters

Gets the parameters of the filter expression.

Declaration

cs-api-definition
[Browsable(true)]
public FilterParameterDictionary Parameters { get; }

Property Value

FilterParameterDictionary

The parameters.

Predicates

Gets a collection containing the filter predicates.

Declaration

cs-api-definition
[Browsable(true)]
public FilterPredicateCollection Predicates { get; }

Property Value

FilterPredicateCollection

Methods

Combine(FilterExpression)

Combines this FilterExpression object with another.

Declaration

cs-api-definition
public FilterExpression Combine(FilterExpression e2)

Parameters

e2

FilterExpression

The second FilterExpression object.

Returns

FilterExpression

The new FilterExpression object.

GetValidPredicateCount()

Gets the valid predicate count.

Declaration

cs-api-definition
public int GetValidPredicateCount()

Returns

int

ToString()

Converts the FilterExpression object to a filter string.

Declaration

cs-api-definition
public override string ToString()

Returns

string

Overrides CompositeFilterDescriptor.ToString()