Caplin Systems - CreateCustomSortRule Method (field, fieldType, order)

Creates a new rule defining how the container records are to be sorted, when the sort field has a custom data type.

The container is sorted by the Caplin Refiner module at Caplin Transformer (see How to use Container Filtering and Sorting).

Declaration Syntax

Visual Basic

Visual C++

ICustomSortRule CreateCustomSortRule(
	string field,
	string fieldType,
	SortOrder order
)

Function CreateCustomSortRule ( _
	field As String, _
	fieldType As String, _
	order As SortOrder _
) As ICustomSortRule

ICustomSortRule^ CreateCustomSortRule(
	String^ field, 
	String^ fieldType, 
	SortOrder order
)

Parameters

field (String): The name of the field that the sort is based on.

fieldType (String): The custom data type of the field (such as "tenor"). The type identifies the filtering algorithm used by Caplin Refiner to sort the container.

order (SortOrder): The order in which the sorted container records are presented.

Return Value

A new ICustomSortRule.

Examples

Assume you want to sort records in ascending order by the "Description" field, which has a custom data type of "tenor". The parameters supplied to CreateCustomFieldSortRule() are:

CopyC#

field = "Description"
fieldType = "tenor"
order = Ascending

Assembly: Caplin.StreamLink (Module: Caplin.StreamLink) Version: 5.0.22.0 (5.0.22.0)