Skip to content

# PDFPortfolio

Namespace: O2S.Components.PDF4NET.Portfolios

Defines a PDF porfolio.

    public class PDFPortfolio : O2S.Components.PDF4NET.PDFDocument

Inheritance Object → PDFDocument → PDFPortfolio

## Constructors

### PDFPortfolio()

Initializes a new PDFPortfolio object.

    public PDFPortfolio()

### PDFPortfolio(String)

Initializes a new PDFPortfolio object.

    public PDFPortfolio(string fileName)

Parameters

`fileName` String
Path to PDF portfolio.

### PDFPortfolio(String, String)

Initializes a new PDFPortfolio object.

    public PDFPortfolio(string fileName, string password)

Parameters

`fileName` String
Path to PDF portfolio.

`password` String
Password for opening the PDF portfolio.

### PDFPortfolio(Stream)

Initializes a new PDFPortfolio object.

    public PDFPortfolio(Stream stream)

Parameters

`stream` Stream
The PDF stream.

### PDFPortfolio(Stream, String)

Initializes a new PDFPortfolio object.

    public PDFPortfolio(Stream stream, string password)

Parameters

`stream` Stream
The PDF stream.

`password` String
Password for opening the PDF portfolio.

## Properties

### AttributeDefinitions

Gets or sets the attribute definitions for this portfolio.

    public PDFPortfolioAttributeDefinitions AttributeDefinitions { get; set; }

Property Value

PDFPortfolioAttributeDefinitions
Attribute definitions for this portfolio, used to define metadata information for items in the portfolio.

### CosDictionary

Gets the COS dictionary asssociated with this object.

    public PDFCosDictionary CosDictionary { get; }

Property Value

PDFCosDictionary
The internal COS dictionary.

Remarks

Incorrect manipulation of the information in the COS dictionary can lead to invalid PDF files.

### CoverPage

Gets the portfolio's cover page.

    public PDFPage CoverPage { get; set; }

Property Value

PDFPage
The page that is displayed when no portfolio items are selected.

### DisplayMode

Gets or sets the portfolio display mode.

    public PDFPortfolioDisplayMode DisplayMode { get; set; }

Property Value

PDFPortfolioDisplayMode
The display mode of this portfolio.

### DocumentSecurityStore

Gets or sets the document security store.

    public PDFDocumentSecurityStore DocumentSecurityStore { get; set; }

Property Value

PDFDocumentSecurityStore
A PDFDocumentSecurityStore object.

Remarks

The document security store includes relevant information for validating digital signatures.
It supports the ability to add this critical information after the signed document has been created and before this information is no longer available.

### Folders

Gets the root folders.

    public PDFPortfolioFolderCollection Folders { get; }

Property Value

PDFPortfolioFolderCollection
The list of root folders.

### ID

Gets or sets the document ID.

    public Byte[] ID { get; set; }

Property Value

Byte[]
The PDF identifier of this document.

### Items

Gets the portfolio items.

    public PDFPortfolioItemCollection Items { get; }

Property Value

PDFPortfolioItemCollection
The list of portfolio items.

### Language

Gets or sets the document language.

    public string Language { get; set; }

Property Value

String
A language identifier that shall specify the natural language for all text in the document except where overridden by language specifications for structure elements or marked content.

### PDFVersion

Gets or sets the PDF version of this PDFPortfolio object.

    public PDFVersion PDFVersion { get; set; }

Property Value

PDFVersion
The PDF version of this PDFPortfolio object.

### SecurityHandler

Gets the document security handler.

    public PDFSecurityHandler SecurityHandler { get; }

Property Value

PDFSecurityHandler
A PDFSecurityHandler that represents the handler used to encrypt the file loaded in this PDFDocument.

Remarks

Both RC4 and AES security handlers are supported.

### SortInformation

Gets or sets the sort information.

    public PDFPortfolioSortInformation SortInformation { get; set; }

Property Value

PDFPortfolioSortInformation
The information for sorting the portfolio items in the user interface.

### StartupDocument

Gets or sets the startup document.

    public PDFPortfolioItem StartupDocument { get; set; }

Property Value

PDFPortfolioItem
The document that is displayed when the portfolio is opened.

### VersionExtension

Gets or sets the PDF version extension.

    public PDFVersionExtension VersionExtension { get; set; }

Property Value

PDFVersionExtension
The extended PDF version this portfolio implements.

## Methods

### Save(Stream, PDFSecurityHandler, Boolean)

Saves this portfolio to the specified stream.

    public void Save(Stream stream, PDFSecurityHandler securityHandler, bool enableObjectCompression)

Parameters

`stream` Stream
The Stream where the portfolio will be saved.

`securityHandler` PDFSecurityHandler
Security handler for encrypting the saved portfolio.

`enableObjectCompression` Boolean
When set to true, the structure of the PDF objects is also compressed. Supported when PDF version >= 1.5