Creates a new expression that filters the records in the container, based on the value of a field in the record, where the field has a
custom data type.
The container is filtered by the Caplin Refiner module at Caplin Transformer (see How to use Container Filtering and Sorting).
Declaration Syntax
C# | Visual Basic | Visual C++ |
ICustomFieldFilterExpression CreateCustomFieldFilterExpression( string field, string fieldType, FieldFilterExpressionOperator oper, string value )
Function CreateCustomFieldFilterExpression ( _ field As String, _ fieldType As String, _ oper As FieldFilterExpressionOperator, _ value As String _ ) As ICustomFieldFilterExpression
ICustomFieldFilterExpression^ CreateCustomFieldFilterExpression( String^ field, String^ fieldType, FieldFilterExpressionOperator oper, String^ value )
Parameters
- field (String)
- The field in the filter expression.
- fieldType (String)
- The custom data type of the field (such as "tenor"). The type identifies the filtering algorithm used by Caplin Refiner to filter the container.
- oper (FieldFilterExpressionOperator)
- The operator in the filter expression.
- value (String)
- The field value in the filter expression.
Return Value
A new ICustomFieldFilterExpression representing the specified filter.
Examples
Assume you want to filter by the "Description" field, which has a custom data type of "tenor", for records that have a a value greater than "5Y". The filter expression for this is
therefore "Description:tenor > 5Y", so the parameters supplied to
CreateCustomFieldFilterExpression() are:
CopyC#
field = "Description" fieldType = "tenor" operator = GreaterThan value = "5Y"