CollectionSort Class

Apitron PDF Kit help

Apitron.PDF.Kit library for .NET

This class represents a collection sort settings. A collection sort identifies the fields that shall be used to sort items in the PortableCollection. The type of sorting depends on the type of data: Text strings shall be ordered lexically from smaller to larger, if ascending order is specified. Lexical ordering is an implementation dependency for interactive PDF processors. Numbers shall be ordered numerically from smaller to larger, if ascending order is specified. Dates shall be ordered from oldest to newest, if ascending order is specified.

Inheritance Hierarchy

SystemObject
  Apitron.PDF.Kit.FixedLayout.ResourcesResource
    Apitron.PDF.Kit.FixedLayout.ResourcesUndefinedResource
      Apitron.PDF.Kit.Interactive.Navigation.DocumentLevel.CollectionsCollectionSort

Namespace: Apitron.PDF.Kit.Interactive.Navigation.DocumentLevel.Collections
Assembly: Apitron.PDF.Kit (in Apitron.PDF.Kit.dll) Version: 2.0.37.0 (2.0.37.0)

Syntax

Copy

public sealed class CollectionSort : UndefinedResource

Public NotInheritable Class CollectionSort
	Inherits UndefinedResource

The CollectionSort type exposes the following members.

Constructors

	Name	Description
	CollectionSort(String, Boolean)	Initializes a new instance of the CollectionSort class.
	CollectionSort(String, Boolean)	Initializes a new instance of the CollectionSort class.

Top

Properties

	Name	Description
	CanBeExported	Gets a value indicating whether this instance can be exported. (Inherited from Resource.)
	FieldNames	Gets the names of fields that the interactive PDF processor shall use to sort the items in the collection. If the value has a single name, it identifies a field described in the parent PortableCollection. If the value is an array, each element of the array shall be a name that identifies a field described in the parent PortableCollection. The array form shall be used to allow additional fields to contribute to the sort, where each additional field shall be used to break ties. More specifically, if multiple collection items have the same value for the first field named in the array, the values for successive fields named in the array shall be used for sorting, until a unique order is determined or until the named fields are exhausted.
	Orders	Gets the orders. If the value has a single boolean, it specifies whether the interactive PDF processor shall sort the items in the collection in ascending order (true) or descending order (false). If the value is an array, each element of the array shall be a boolean value that specifies whether the entry at the same index in the FieldNames array shall be sorted in ascending or descending order. If the number of entries in the Orders array is larger than the number of entries in the FieldNames array the extra entries in the Orders array shall be ignored.If the number of entries in the Orders array is less than the number of entries in the FieldNames array the missing entries in the Orders array shall be assumed to be true.
	ResourceType	Gets the resource type. (Inherited from Resource.)

Top

Reference

Apitron.PDF.Kit.Interactive.Navigation.DocumentLevel.Collections Namespace