Click or drag to resize

PdfPortfolio Class

Specifies how a conforming reader's user interface presents collections of file attachments.

If Portfolio property of a PdfDocument is not , the conforming reader shall present the document as a PDF Portfolio (also known as portable collection).

The file attachments comprising a PDF Portfolio shall be located in the EmbeddedFiles name tree. All attachments in that tree are in the PDF Portfolio; any attachments not in that tree are not.

When a conforming reader first opens a PDF Portfolio document, it shall display the contents of the InitialFile, along with a list of the documents present in the EmbeddedFiles name tree. The document list shall include the additional document information specified by the Fields. The initial document may be the container PDF (if InitialFile is ) or one of the embedded documents.

Inheritance Hierarchy
SystemObject
  SautinSoft.PdfPdfObject
    SautinSoft.Pdf.PortfoliosPdfPortfolio

Namespace: SautinSoft.Pdf.Portfolios
Assembly: SautinSoft.Pdf (in SautinSoft.Pdf.dll) Version: 2024.6.18
Syntax
public sealed class PdfPortfolio : PdfObject

The PdfPortfolio type exposes the following members.

Properties
 NameDescription
Public propertyColors(Optional; PDF 2.0) A PdfPortfolioColors specifying a suggested set of colors for use by a PdfPortfolio layout.
Public propertyFields Gets the Portfolio fields. If empty, the conforming reader may choose useful defaults that are known to exist in a PdfFileSpecification, such as the file name, file size, and modified date.
Public propertyFiles Gets the root EmbeddedFiles contained in the PdfPortfolio.
Public propertyFolders Gets the root folders contained in the PdfPortfolio.
Public propertyInitialFile

(Optional) The embedded file that shall be initially presented in the user interface. If the InitialFile is or is not a valid PdfFileSpecification, the initial file shall be the current document (PDF Portfolio). If the InitialFile is valid and does not match any file in the EmbeddedFiles name tree, 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 name tree, the interactive PDF processor shall display an empty preview window.

(PDF 2.0) For unencrypted wrapper documents for an encrypted payload document the InitialFile is required, and shall identify the encrypted payload entry in the EmbeddedFiles name tree.

Public propertyMetadata(Optional; PDF 1.4) A metadata stream containing metadata for the component.
(Inherited from PdfObject)
Public propertySortLevels

Gets the sort levels by which files and folders in the PdfPortfolio are sorted.

If multiple files and folders in the PdfPortfolio have the same value for the field specified by the first level in the collection, the values for fields specified by the successive levels in the collection shall be used for sorting, until a unique order is determined or until the sort levels are exhausted.

Public propertySplitDirection(Optional; PDF 2.0) The orientation of the PdfPortfolio splitter bar.
Public propertySplitPosition(Optional; PDF 2.0) The initial position of the PdfPortfolio splitter bar, specified as a percentage of the available window area. Values shall range from 0 to 100. The property shall be ignored if SplitDirection is set to None.
Public propertyViewType

(Optional) The initial view.

Default value: Details.

Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Extension Methods
 NameDescription
Public Extension MethodGetArray Gets the PdfArray that serves as a backing storage of the specified PdfObject or if no PdfArray serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Public Extension MethodGetDictionary Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Public Extension MethodGetOrAddDictionary Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Top
See Also