Documentation

Class FilterExpression

Represents a filter expression.

Inheritance
System.Object
FilterDescriptor
CompositeFilterDescriptor
FilterExpression
CompositeFilterExpression
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.Data
Assembly: Telerik.WinControls.GridView.dll

Syntax

public class FilterExpression : CompositeFilterDescriptor, INotifyPropertyChanged, INotifyPropertyChangingEx, ICloneable

Constructors

FilterExpression()

Creates an instance of the FilterExpression class.

Declaration
public FilterExpression()

FilterExpression(String)

Creates an instance of the FilterExpression class.

Declaration
public FilterExpression(string fieldName)
Parameters
System.String fieldName

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

FilterExpression(String, FilterExpression.BinaryOperation, GridKnownFunction, Object[])

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

Declaration
public FilterExpression(string fieldName, FilterExpression.BinaryOperation binaryOperation, GridKnownFunction function, params object[] values)
Parameters
System.String fieldName

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

The binary operation that is used by the new FilterExpression.
GridKnownFunction function

The GridKnownFunction that is used to create the FilterPredicate object.
System.Object[] values

The values that are used to create the FilterPredicate object.

FilterExpression(FilterExpression.BinaryOperation, GridKnownFunction, Object[])

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

Declaration
public FilterExpression(FilterExpression.BinaryOperation binaryOperation, GridKnownFunction function, params object[] values)
Parameters
FilterExpression.BinaryOperation binaryOperation

The binary operation that is used by the new FilterExpression.
GridKnownFunction function

The GridKnownFunction that is used to create the FilterPredicate object.
System.Object[] values

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
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
public string FieldName { get; set; }
Property Value
System.String

IsFilterEditor

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

Declaration
public override bool IsFilterEditor { get; }
Property Value
System.Boolean

true if this instance is default; otherwise, false.
Overrides

IsValid

Gets a value indicating whether the filter expression is valid.

Declaration
public bool IsValid { get; }
Property Value
System.Boolean

Parameters

Gets the parameters of the filter expression.

Declaration
public FilterParameterDictionary Parameters { get; }
Property Value
FilterParameterDictionary

The parameters.

Predicates

Gets a collection containing the filter predicates.

Declaration
public FilterPredicateCollection Predicates { get; }
Property Value
FilterPredicateCollection

Methods

Combine(FilterExpression)

Combines this FilterExpression object with another.

Declaration
public FilterExpression Combine(FilterExpression e2)
Parameters
FilterExpression e2

The second FilterExpression object.
Returns
FilterExpression

The new FilterExpression object.

GetValidPredicateCount()

Gets the valid predicate count.

Declaration
public int GetValidPredicateCount()
Returns
System.Int32

ToString()

Converts the FilterExpression object to a filter string.

Declaration
public override string ToString()
Returns
System.String

Overrides

Extension Methods