PdfDocumentProcessor.LoadDocument(String) Method

Opens a PDF document from the specified file.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Docs.v23.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public void LoadDocument(
    string path
)

VB.NET

Public Sub LoadDocument(
    path As String
)

Parameters

Name	Type	Description
path	String	A String value, specifying the file path.

Remarks

The PDF Document API component locks a PDF file until it is loaded (this behavior is similar to that of Adobe® Reader®). Use the PdfDocumentProcessor.LoadDocument(String, Boolean) method overload to unlock the PDF file.

If the PdfProcessor fails to load the document, an ArgumentException is thrown.

Example

View Example

The code sample below uses PdfFormData to set form field values:

PdfFillForm.cs

// Load a document with an interactive form.
using (PdfDocumentProcessor documentProcessor = new PdfDocumentProcessor()) {
    documentProcessor.LoadDocument(filePath + fileName + ".pdf");

    // Obtain interactive form data from a document.
    PdfFormData formData = documentProcessor.GetFormData();

    // Specify the value for FirstName and LastName text boxes.
    formData["FirstName"].Value = "Janet";
    formData["LastName"].Value = "Leverling";

    // Specify the value for the Gender radio group.
    formData["Gender"].Value = "Female";

    // Specify the check box checked appearance name.
    formData["Check"].Value = "Yes";

    // Specify values for the Category list box.
    formData["Category"].Value = new string[] { "Entertainment", "Meals", "Morale" };

    // Obtain data from the Address form field and specify values for Address child form fields.
    PdfFormData address = formData["Address"];

    // Specify the value for the Country combo box. 
    address["Country"].Value = "United States";

    // Specify the value for City and Address text boxes. 
    address["City"].Value = "California";
    address["Address"].Value = "20 Maple Avenue";

    // Apply data to the interactive form. 
    documentProcessor.ApplyFormData(formData);

    // Save the modified document.
    documentProcessor.SaveDocument(filePath + fileName + "_new.pdf");
}

PdfFillForm.vb

' Load a document with an interactive form.
Using documentProcessor As New PdfDocumentProcessor()
    documentProcessor.LoadDocument(filePath & fileName & ".pdf")

    ' Obtain interactive form data from a document.
    Dim formData As PdfFormData = documentProcessor.GetFormData()

    ' Specify the value for FirstName and LastName text boxes.
    formData("FirstName").Value = "Janet"
    formData("LastName").Value = "Leverling"

    ' Specify the value for the Gender radio group.
    formData("Gender").Value = "Female"

    ' Specify the check box checked appearance name.
    formData("Check").Value = "Yes"

    ' Specify values for the Category list box.
    formData("Category").Value = New String() { "Entertainment", "Meals", "Morale" }

    ' Obtain data from the Address form field and specify values for Address child form fields.
    Dim address As PdfFormData = formData("Address")

    ' Specify the value for the Country combo box. 
    address("Country").Value = "United States"

    ' Specify the value for City and Address text boxes. 
    address("City").Value = "California"
    address("Address").Value = "20 Maple Avenue"

    ' Apply data to the interactive form. 
    documentProcessor.ApplyFormData(formData)

    ' Save the modified document.
    documentProcessor.SaveDocument(filePath & fileName & "_new.pdf")

End Using

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the LoadDocument(String) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

pdf-document-api-extract-pages-from-document/CS/ExtractDocumentPages/Program.cs#L8

using(PdfDocumentProcessor source = new PdfDocumentProcessor()) {
    source.LoadDocument("..\\..\\Document.pdf");
    for(int i = 0; i < source.Document.Pages.Count; i++) {

pdf-document-api-operate-pdf-content-at-runtime/CS/WindowsFormsApplication1/MainForm.cs#L27

using (PdfDocumentProcessor documentProcessor = new PdfDocumentProcessor()) {
    documentProcessor.LoadDocument(filePath);
    documentText = documentProcessor.Text;

pdf-document-api-copy-pages/CS/CopyPage/Program.cs#L8

using (PdfDocumentProcessor source = new PdfDocumentProcessor()) {
    source.LoadDocument("..\\..\\Document1.pdf");
    using (PdfDocumentProcessor target = new PdfDocumentProcessor()) {

pdf-document-api-fill-interactive-form-fields/CS/PdfFormFilling/PdfFormFilling.cs#L23

using (PdfDocumentProcessor documentProcessor = new PdfDocumentProcessor()) {
    documentProcessor.LoadDocument(filePath + fileName + ".pdf");

pdf-document-api-delete-pages-from-document/CS/PdfDeletePageExample/Program.cs#L16

{
    pdfDocumentProcessor.LoadDocument("..\\..\\docs\\TextDelete.pdf");
    for (int i = pdfDocumentProcessor.Document.Pages.Count; i > 0; i--)

VB.NET

pdf-document-api-extract-pages-from-document/VB/ExtractDocumentPages/Program.vb#L9

Using source As PdfDocumentProcessor = New PdfDocumentProcessor()
    source.LoadDocument("..\..\Document.pdf")
    For i As Integer = 0 To source.Document.Pages.Count - 1

pdf-document-api-operate-pdf-content-at-runtime/VB/WindowsFormsApplication1/MainForm.vb#L29

Using documentProcessor As PdfDocumentProcessor = New PdfDocumentProcessor()
    documentProcessor.LoadDocument(filePath)
    documentText = documentProcessor.Text

pdf-document-api-copy-pages/VB/CopyPage/Program.vb#L9

Using source As PdfDocumentProcessor = New PdfDocumentProcessor()
    source.LoadDocument("..\..\Document1.pdf")
    Using target As PdfDocumentProcessor = New PdfDocumentProcessor()

pdf-document-api-fill-interactive-form-fields/VB/PdfFormFilling/PdfFormFilling.vb#L24

Using documentProcessor As PdfDocumentProcessor = New PdfDocumentProcessor()
    documentProcessor.LoadDocument(filePath & fileName & ".pdf")
    ' Get names of interactive form fields.

pdf-document-api-delete-pages-from-document/VB/PdfDeletePageExample/Program.vb#L13

Using pdfDocumentProcessor As PdfDocumentProcessor = New PdfDocumentProcessor()
    pdfDocumentProcessor.LoadDocument("..\..\docs\TextDelete.pdf")
    For i As Integer = pdfDocumentProcessor.Document.Pages.Count To 0 + 1 Step -1