Class FilterExpression

This class encapsulates the information needed to define a filter.

Inheritance

System.Object

FilterExpression

Namespace: Syncfusion.XlsIO.Implementation.PivotAnalysis

Assembly: Syncfusion.XlsIO.Portable.dll

Syntax

public class FilterExpression : Object

Constructors

FilterExpression()

Initializes a new instance of the FilterExpression class.

Declaration

public FilterExpression()

FilterExpression(String)

Initializes a new instance of the FilterExpression class with the field name of a PivotItem.

Declaration

public FilterExpression(string dimensionName)

Parameters

Type	Name	Description
System.String	dimensionName	Field name of the PivotItem.

FilterExpression(String, String)

Initializes a new instance of the FilterExpression class with the field name and expression of a PivotItem.

Declaration

public FilterExpression(string name, string expression)

Parameters

Type	Name	Description
System.String	name	Field name of the PivotItem.
System.String	expression	Logical expression defining the filter.

FilterExpression(String, String, String)

Initializes a new instance of the FilterExpression class with the field name, field header and expression of a PivotItem.

Declaration

public FilterExpression(string dimensionName, string dimensionHeader, string expression)

Parameters

Type	Name	Description
System.String	dimensionName	Field name of the PivotItem.
System.String	dimensionHeader	Field header of the PivotItem.
System.String	expression	Logical expression defining the filter.

FilterExpression(String, String, String, String)

Initializes a new instance of the FilterExpression class with the field name, field header, expression and format of a PivotItem.

Declaration

public FilterExpression(string dimensionName, string dimensionHeader, string expression, string format)

Parameters

Type	Name	Description
System.String	dimensionName	Field name of the PivotItem.
System.String	dimensionHeader	Field header of the PivotItem.
System.String	expression	Logical expression defining the filter.
System.String	format	Format of the filter expression.

Properties

CaseSensitive

Gets or sets whether the expression should be treated in a case-sensitive manner.

Declaration

public bool CaseSensitive { get; set; }

Property Value

Type
System.Boolean

DimensionHeader

Gets or sets the field header.

Declaration

public string DimensionHeader { get; set; }

Property Value

Type
System.String

DimensionName

Gets or sets the field name of the PivotItem.

Declaration

public string DimensionName { get; set; }

Property Value

Type
System.String

Error

Gets the last error that was logged during the compilation and calculation phase.

Declaration

public ExpressionError Error { get; }

Property Value

Type
ExpressionError

ErrorString

Gets a descriptive string for the last occurred error.

Declaration

public string ErrorString { get; }

Property Value

Type
System.String

Evaluator

Evaluates the given value.

Declaration

public Delegate Evaluator { get; set; }

Property Value

Type
System.Delegate

Expression

Gets or sets the well-formed logical expression that defines this filter expression.

Declaration

public string Expression { get; set; }

Property Value

Type
System.String

FieldCaption

Gets or sets the field caption.

Declaration

public string FieldCaption { get; set; }

Property Value

Type
System.String

Format

Gets or sets the format of the filter expression.

Declaration

public string Format { get; set; }

Property Value

Type
System.String

Name

Gets or sets the name of this filter expression.

Declaration

public string Name { get; set; }

Property Value

Type
System.String

Tag

Gets or sets other information related to filter expression.

Declaration

public object Tag { get; set; }

Property Value

Type	Description
System.Object	Filter expression information

Methods

ComputedValue(Object)

Used to calculate the value.

Declaration

public object ComputedValue(object component)

Parameters

Type	Name	Description
System.Object	component

Returns

Type
System.Object

ComputedValue(Object, Boolean, PivotEngine)

Use this method to retrieve the computed value of this expression on an object.

Declaration

public object ComputedValue(object component, bool loadInBackground, PivotEngine engine)

Parameters

Type	Name	Description
System.Object	component	The object to be evaluated.
System.Boolean	loadInBackground	Represents the boolean value.
PivotEngine	engine	Used to provide the support for calculation.

Returns

Type	Description
System.Object	The computed value.

Remarks

The first time this method is called, a delegate for the FilterExpression is created, and then this delegate call is passed into the component. Subsequent calls to this method just result into the existing delegate call.