TTMSFNCFilterViewExpressions.AddOrUpdateExpression Method
Adds or updates an expression with a typed filter value and explicit operator.
API unit family: TMSFNCFilterView
Declaring type: TTMSFNCFilterViewExpressions
Overloads
Overload 1
Adds or updates an expression with a typed filter value and explicit operator.
function AddOrUpdateExpression(APropertyValue: string; AExpressionOperator: TTMSFNCFilterBuilderExpressionOperator; AFilterValue: TTMSFNCValue; AAddToFilter: Boolean = True; AFilterFieldName: string = ''; ADataType: TTMSFNCFilterBuilderDataType = fdtAutomatic): TTMSFNCFilterViewExpression; overload;
Parameters
| Name | Description |
|---|---|
APropertyValue |
Property value that identifies the expression. |
AExpressionOperator |
Operator used when the expression creates a filter item. |
AFilterValue |
Typed value assigned to the expression. |
AAddToFilter |
When True, the expression creates or updates a filter item when selected. |
AFilterFieldName |
Optional field name for the generated filter item. |
ADataType |
Field data type used to interpret the value. |
Returns
The added or updated expression.
Overload 2
Adds or updates an expression with text filter value and explicit operator.
function AddOrUpdateExpression(APropertyValue: string; AExpressionOperator: TTMSFNCFilterBuilderExpressionOperator; AFilterValueText: string = ''; AAddToFilter: Boolean = True; AFilterFieldName: string = ''; ADataType: TTMSFNCFilterBuilderDataType = fdtAutomatic): TTMSFNCFilterViewExpression; overload;
Parameters
| Name | Description |
|---|---|
APropertyValue |
Property value that identifies the expression. |
AExpressionOperator |
Operator used when the expression creates a filter item. |
AFilterValueText |
Text value assigned to the expression. |
AAddToFilter |
When True, the expression creates or updates a filter item when selected. |
AFilterFieldName |
Optional field name for the generated filter item. |
ADataType |
Field data type used to interpret the value text. |
Returns
The added or updated expression.
Overload 3
Adds or updates an expression with text filter value and the default operator.
function AddOrUpdateExpression(APropertyValue: string; AFilterValueText: string = ''; AAddToFilter: Boolean = True; AFilterFieldName: string = ''; ADataType: TTMSFNCFilterBuilderDataType = fdtAutomatic): TTMSFNCFilterViewExpression; overload;
Parameters
| Name | Description |
|---|---|
APropertyValue |
Property value that identifies the expression. |
AFilterValueText |
Text value assigned to the expression. |
AAddToFilter |
When True, the expression creates or updates a filter item when selected. |
AFilterFieldName |
Optional field name for the generated filter item. |
ADataType |
Field data type used to interpret the value text. |
Returns
The added or updated expression.