PortableCollection Class

Apitron PDF Kit help
Apitron.PDF.Kit library for .NET
This class repsents a portable collection. A collection specifies the viewing and organisational characteristics of portable collections. If it is present in a PDF document, the interactive PDF processor shall present the document as a portable collection. When an interactive PDF processor first opens a PDF document containing a collection, it shall display the contents according to the View of the collection. The initial document may be the container PDF or one of the embedded documents as specified by the InitialDocument in the collection. Note: The page content in the initial document needs to contain information that helps the user understand what is contained in the collection, such as a title and an introductory paragraph. The file attachments comprising a collection shall be located in the [!:FixedDocument.Names.Attachments] tree. All attachments in that tree are in the collection; any attachments not in that tree are not. For a PDF document that is an unencrypted wrapper for an encrypted payload document, the [!:FixedDocument.Names.Attachments] tree shall contain exactly one entry, for the encrypted payload document. Beginning with PDF 2.0, a portable collection may include an interactive layout, or presentation, of the collection contents. The collection layout or presentation is called a navigator.For more information about navigators please see Navigator.
Inheritance Hierarchy


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

public sealed class PortableCollection : UndefinedResource

The PortableCollection type exposes the following members.


Public propertyCanBeExported
Gets a value indicating whether this instance can be exported.
(Inherited from Resource.)
Public propertyColors
Gets or sets a collection colors specifying a suggested set of colours for use by a collection layout.
Public propertyFolder
Gets or sets a folder that is the single common ancestor of all other folders in a portable collection.
Public propertyInitialDocument
Gets or sets an EmbeddedFile, determining the document that shall be initially presented in the user interface. If the InitialDocument entry is missing, the initial document shall be the one that contains the collection. If the InitialDocument entry is a valid EmbeddedFile that does not match any file in the [!:FixedDocument.Names.Attachments], the interactive PDF processor shall select the first item from the list of files to display in its user interface; if no files exist in the [!:FixedDocument.Names.Attachments], the interactive PDF processor shall display an empty preview window. (PDF 2.0) For unencrypted wrapper documents for an encrypted payload document the InitialDocument entry is required, and shall identify the encrypted payload entry in the [!:FixedDocument.Names.Attachments].
Public propertyNavigator
Gets or sets a navigator that provides the collection view mode.
Public propertyResourceType
Gets the resource type.
(Inherited from Resource.)
Public propertySchema
Gets or sets a collection schema. If absent, the interactive PDF processor may choose useful defaults that are known to exist in a file specification dictionary, such as the file name, file size, and modified date.
Public propertySort
Gets or sets collection sort, which specifies the order in which items in the collection shall be sorted in the user interface.
Public propertySplit
Gets or sets a collection split that specifies the orientation of the splitter bar in the user interface provided by the interactive PDF processor. If Split is not present, the preferred orientation is determined by the value of the View key. A value of D (or no value) shall indicate a horizontal orientation, while a value of T shall indicate a vertical orientation. No splitter shall be used if the View key has a value of H or C.
Public propertyView
Gets or sets the initial view mode.
See Also