PdfDocumentProcessor.LoadDocument(String, Boolean) Method

Opens a PDF document from the specified file using detach stream mode.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Docs.v18.2.dll

Declaration

C#

public void LoadDocument(
    string path,
    bool detachStreamAfterLoadComplete
)

VB.NET

Public Sub LoadDocument(
    path As String,
    detachStreamAfterLoadComplete As Boolean
)

Parameters

Name	Type	Description
path	String	A String value, specifying the file path.
detachStreamAfterLoadComplete	Boolean	true if the PDF Document API component unlocks a file until it is loaded; otherwise false.

Remarks

The PDF Document API component locks a file until it is loaded by default (the detachStreamAfterLoadComplete parameter is set to false). If you do not want the PDF Document API component to lock the file, call the overloaded LoadDocument method with the detachStreamAfterLoadComplete parameter enabled.

Example

The example shows how to fill an existing interactive form using field names.

To obtain interactive form data, call the PdfDocumentProcessor.GetFormData method. Then, specify a value for a form field using the PdfFormData.Value property.

To obtain the names of the interactive form fields, use the PdfDocumentProcessor.GetFormFieldNames method.

To apply data to the interactive form, call the PdfDocumentProcessor.ApplyFormData method.

To learn how to get a checked appearance name for the check box, see the How to: Obtain a Checked Appearance Name for a Check Box example.

To learn how to get a checked appearance name for the radio button, see the How to: Obtain a Checked Appearance Name for Each Radio Button in the Radio Group example.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-programmatically-fill-an-interactive-form-with-values-t210253

PdfFormFilling.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")

    btnFillFormData.Enabled = False
    btnLoadFilledPDF.Enabled = True
End Using

PdfFormFilling.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");

    btnFillFormData.Enabled = false;
    btnLoadFilledPDF.Enabled = true;
}

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the LoadDocument(String, Boolean) 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-viewer-in-aspnet-web-applications/CS/PdfViewer.ascx.cs#L57

if (!String.IsNullOrEmpty(value)) {
    DocumentProcessor.LoadDocument(Server.MapPath(value), true);
    BindDataView();

VB.NET

pdf-viewer-in-aspnet-web-applications/VB/PdfViewer.ascx.vb#L65

If Not System.[String].IsNullOrEmpty(value) Then
    Me.DocumentProcessor.LoadDocument(Me.Server.MapPath(value), True)
    Me.BindDataView()