CollectionSortItem Class Documentation

class CollectionSortItem : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:
SystemIDisposable

Detailed Description

Stores data about fields that viewers use for sorting collection items.

Collections are aslo known as portfolios.

Referenced by

Constructor & Destructor Documentation

CollectionSortItem

CollectionSortItem(string fieldID, bool order)

Parameters

fieldID: string

the schema field's id.

order: bool

true for ascending, false for descending

CCollectionSortItem allows to construct sort item which will be used for collection sorting.

Property Documentation

Ascending

bool Ascending[get]

Gets whether the sort order is ascending.

Name

string Name[get]

Gets the field name used for sorting.

This is the schema field identifier that determines which collection field is used as the sort key.

Member Function Documentation

Dispose

void Dispose()

Returns:

void