Collection Class Documentation
class CollectionNamespace:datalogics_interface
Detailed Description
Allows for manipulation of PDF collections, or portfolios.
The class illustrates how to process a collection's schema. It also describes sorting of a portfolio.
Referenced by
Constructor & Destructor Documentation
Collection
Collection(Collection && )Parameters
~Collection
~Collection()Member Function Documentation
change_view_mode
void change_view_mode(CollectionViewType view, CollectionSplitType split)Parameters
view: CollectionViewTypeone of the members of CollectionViewMode enum.
split: CollectionSplitTypeenum of split mode (selector)
Returns:
voidSetCollectionView sets view mode value to the Collection.
get_schema
CollectionSchema get_schema()Returns:
CollectionSchemaSchema object.
GetSchema allows to obtain Schema object for current Collection.
The Schema object does not have constructor. Only Collection is able to create Schema.
get_sort
std::vector< CollectionSortItem > get_sort()Returns:
std::vector< CollectionSortItem >the list of CollectionSortItem, which contains field/fields name to sort Collection by and sort order.
GetSort gets sort parameters for the Collection.
operator=
Collection & operator=(Collection && )Parameters
Returns:
Collection &set_sort
void set_sort(const std::vector< CollectionSortItem > & sort_items)Parameters
sort_items: const std::vector< CollectionSortItem > &the list of CollectionSortItem.
Returns:
voidSetSort allows to set field/fields to sort by as well as sort order (ascending or descending).