TRIM.SDK.TrimSearchSortItem Class Reference

The TrimSearchSortItem is a class representing a sort criteria. More...

Public Member Functions
	TrimSearchSortItem (SearchClauseIds clauseId)
	Construct a sort item that is ascending More...
	TrimSearchSortItem (SearchClauseIds clauseId, bool isAscending)
	Construct a sort item that is ascending or descending More...
	TrimSearchSortItem (FieldDefinition userDefinedField)
	Construct a sort item that is ascending, based on user-defined field More...
	TrimSearchSortItem (FieldDefinition userDefinedField, bool isAscending)
	Construct a sort item that is ascending or descending More...

Properties
bool	IsFieldSort [get]
	Gets a boolean property indicating that this sort item will be sorting by the value of a user-defined field More...
SearchClauseIds	ClauseId [get]
	Gets the SearchClauseIds property that indicates which property is used to sort by. More...
FieldDefinition?	Field [get]
	Gets the FieldDefintion that indicates which field is used to sort by. More...
bool	IsAscending [get]
	Gets a boolean value indicating if the sort is ascending or descending. More...

Detailed Description

The TrimSearchSortItem is a class representing a sort criteria.

Constructor & Destructor Documentation

TrimSearchSortItem() [1/4]

TRIM.SDK.TrimSearchSortItem.TrimSearchSortItem

(

SearchClauseIds

clauseId

)

Construct a sort item that is ascending

TrimSearchSortItem() [2/4]

TRIM.SDK.TrimSearchSortItem.TrimSearchSortItem	(	SearchClauseIds	clauseId,
		bool	isAscending
	)

Construct a sort item that is ascending or descending

TrimSearchSortItem() [3/4]

TRIM.SDK.TrimSearchSortItem.TrimSearchSortItem

(

FieldDefinition

userDefinedField

)

Construct a sort item that is ascending, based on user-defined field

TrimSearchSortItem() [4/4]

TRIM.SDK.TrimSearchSortItem.TrimSearchSortItem	(	FieldDefinition	userDefinedField,
		bool	isAscending
	)

Construct a sort item that is ascending or descending

Property Documentation

ClauseId

SearchClauseIds TRIM.SDK.TrimSearchSortItem.ClauseId

get

Gets the SearchClauseIds property that indicates which property is used to sort by.

Field

FieldDefinition? TRIM.SDK.TrimSearchSortItem.Field

get

Gets the FieldDefintion that indicates which field is used to sort by.

IsAscending

bool TRIM.SDK.TrimSearchSortItem.IsAscending

get

Gets a boolean value indicating if the sort is ascending or descending.

IsFieldSort

bool TRIM.SDK.TrimSearchSortItem.IsFieldSort

get

Gets a boolean property indicating that this sort item will be sorting by the value of a user-defined field