Class ExpressionPropertyDescriptor
Class that illustrates the expression field support along with filtering in PivotEngine.
Inheritance
Namespace: Syncfusion.XlsIO.Implementation.PivotAnalysis
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class ExpressionPropertyDescriptor : PropertyDescriptorConstructors
ExpressionPropertyDescriptor(String, Attribute[], String, String, FilterHelper)
A constructor that initializes the attributes of "ExpressionPropertyDescriptor" object.
Declaration
public ExpressionPropertyDescriptor(string name, Attribute[] attributes, string expression, string format, FilterHelper helper)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | Name of the expression field. |
| System.Attribute[] | attributes | Attributes. |
| System.String | expression | Expression. |
| System.String | format | Format. |
| FilterHelper | helper | An object that holds attributes to compute filter values and expressions. |
Properties
ComponentType
When overridden in a derived class, gets the type of the component this property is bound to.
Declaration
public override Type ComponentType { get; }Property Value
| Type | Description |
|---|---|
| System.Type |
Exp
Gets or sets the logical expression for filtering.
Declaration
public FilterExpression Exp { get; set; }Property Value
| Type | Description |
|---|---|
| FilterExpression |
Expression
Gets or sets the expression.
Declaration
public string Expression { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Format
Gets or sets a format associated with the value of this expression.
Declaration
public string Format { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
IsReadOnly
Checks whether the data is read-only.
Declaration
public override bool IsReadOnly { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
PropertyType
Returns the object datatype.
Declaration
public override Type PropertyType { get; }Property Value
| Type | Description |
|---|---|
| System.Type |
Methods
CanResetValue(Object)
When overridden in a derived class, returns whether re-setting an object changes its value.
Declaration
public override bool CanResetValue(object component)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | component | The component to test re-setting capability. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Retuens true if re-setting the component changes its value; otherwise, false. |
GetValue(Object)
Gets the value of the concerned data and returns the values based on the format associated with it.
Declaration
public override object GetValue(object component)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | component |
Returns
| Type | Description |
|---|---|
| System.Object |
ResetValue(Object)
Resets the value based on expression.
Declaration
public override void ResetValue(object component)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | component |
SetValue(Object, Object)
When overridden in a derived class, sets the value of the component to a different value.
Declaration
public override void SetValue(object component, object value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | component | The component with the property value that is to be set. |
| System.Object | value | The new value. |
ShouldSerializeValue(Object)
When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted.
Declaration
public override bool ShouldSerializeValue(object component)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | component | The component with the property to be examined for persistence. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Returns true if the property should be persisted; otherwise, false. |