Class FilterHelper

This class encapsulates the support for computing filter values and expressions.

Inheritance

System.Object

FilterHelper

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.PivotAnalysis.Base

Assembly: Syncfusion.PivotAnalysis.Base.dll

Syntax

public class FilterHelper

Constructors

FilterHelper()

Initializes a new instance of the FilterHelper class.

Declaration

public FilterHelper()

Properties

CaseSensitive

Gets or sets value to indicate whether the expression should be treated in a case-sensitive manner. The default value is true.

Declaration

public bool CaseSensitive { get; set; }

Property Value

Type
System.Boolean

Count

Gets the number of filter expressions contained in this helper class.

Declaration

public int Count { get; }

Property Value

Type
System.Int32

Item[Int32]

Gets the particular filter expression in the order it was added.

Declaration

public FilterExpression this[int i] { get; }

Parameters

Type	Name	Description
System.Int32	i	The index of desired filter expression.

Property Value

Type	Description
FilterExpression	The filter expression.

Methods

AddFilterExpression(String, String)

Adds a filter expression.

Declaration

public void AddFilterExpression(string name, string expression)

Parameters

Type	Name	Description
System.String	name	The name of filter expression.
System.String	expression	A string holding a well-formed logical expression.

Clear()

Clears all filter expressions.

Declaration

public void Clear()

RemoveFilterExpression(FilterExpression)

Removes a filter expression.

Declaration

public bool RemoveFilterExpression(FilterExpression exp)

Parameters

Type	Name	Description
FilterExpression	exp	The name of the filter expression to be removed.

Returns

Type	Description
System.Boolean	Returns true if the expression was successfully removed; otherwise, false.