Open a Document

ComPDFKit supports opening local PDF documents or creating new ones.

Open a Local PDF Document

The steps to open a local PDF document using a file path are as follows:

1. Obtain the local file path.
2. Initialize a CDFDocument object using the file path.

This example shows how to open a local PDF document:

// Initialize a `CPDFDocument` object using the PDF file path.
CPDFDocument document = CPDFDocument.InitWithFilePath(myFilePath);

if(document.ErrorType != CPDFDocumentError.CPDFDocumentErrorSuccess
  && document.ErrorType != CPDFDocumentError.CPDFDocumentPasswordError)
{
    return;
}

// For encrypted documents, it is necessary to use a password to decrypt them.
if(document.IsLocked)
{
    document.UnlockWithPassword(password);
}

Open from FileStream

The steps to open a PDF document using a FileStream are as follows:

1. Obtain the FileStream.
2. Initialize a CPDFDocument object using the FileStream.

FileStream fs = File.OpenRead(myFilePath);
CPDFDocument document = CPDFDocument.InitWithStream(fs);

Open from URL

The steps to open a PDF document using a URL are as follows:

1. Obtain the URL of the file.
2. Initialize a CPDFDocument object using the URL.

string url = "https://www.compdf.com/webviewer/example/developer_guide_web.pdf";
CPDFDocument document = CPDFDocument.InitWithUrl(url);

Create a New PDF Document

This example shows how to create a new PDF document:

CPDFDocument document = CPDFDocument.CreateDocument();

By default, a newly created document doesn't contain any pages. Please refer to the "Document Editing" functionality to learn how to create new pages and add existing pages to the document.

Explanation of Open Document Status

This is the explanation of opening document status:

Error Code	Description
CPDFDocumentErrorSuccess	Document opened successfully.
CPDFDocumentUnknownError	Unknown error.
CPDFDocumentFileError	File not found or cannot be opened.
CPDFDocumentFormatError	Format Error: not a PDF or corrupted.
CPDFDocumentPasswordError	Password required or incorrect password.
CPDFDocumentSecurityError	Unsupported security scheme.
CPDFDocumentPageError	Page not found or content error.