PDFDocument Constructor(string)

Summary

Initializes a new PDFDocument from a specified PDF file.

Syntax

C++

Java

public PDFDocument( 
   string fileName 
)

Public Function New( _ 
   ByVal fileName As String _ 
)

public PDFDocument(String fileName)

public: 
PDFDocument(  
   String^ fileName 
)

fileName
The name of an existing PDF file.

Remarks

The PDFDocument class encapsulates a PDF document on disk and allows you to read the pages, objects and images from the document.

fileName must contain the name of an existing and valid PDF file on disk. If the PDF file is encrypted, then use the PDFDocument(string fileName, string password) constructor. You can check whether a PDF is encrypted using the PDFFile.IsEncrypted method.

This method will initialize the members of PDFDocument as follows:

FileName: will be set to fileName.
Password: will be set to null.
IsEncrypted: will be set false since this method cannot open an encrypted PDF file.
Resolution: will be set to the default value used to load PDF files set in the static DefaultResolution property.
Pages: will be initialized to list of PDFDocumentPage objects, one item for each page found in the PDF document. Not all the PDFDocumentPage members will be initialized since the PDFDocument constructor does not read any PDF objects by default. Refer to PDFDocumentPage for more information.
DocumentProperties: will be initialized with PDF document properties or metadata read from the file.
SecurityOptions: will be initialized with PDF document security and encryption options read from the file.
FileType: will be initialized with PDF document file type or version read from the file.
InternalLinks: will be initialized to null. The PDFDocument constructor will not read the PDF document structure by default. Instead, use the ParseDocumentStructure method to read the structure and populate InternalLinks.
Bookmarks: will be initialized to null. The PDFDocument constructor will not read the PDF document structure by default. Instead, use the ParseDocumentStructure method to read the structure and populate Bookmarks.

Use PDFDocument Constructor(Stream) to create a PDF document from a .NET stream.

Example

For an example, refer to PDFDocument.

Requirements

Help Version 20.0.2020.4.3