PdfDocumentProcessor.SaveDocument(String) Method

Saves the current document to the specified file path.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Docs.v18.2.dll

Declaration

C#

public void SaveDocument(
    string path
)

VB.NET

Public Sub SaveDocument(
    path As String
)

Parameters

Name	Type	Description
path	String	A String value, specifying the location of the saved document.

Remarks

The PDF Document API component locks a file while a document is saved (since the SaveDocument method uses the detachStream parameter set to false). To unlock the file, call another overloaded SaveDocument method with the detachStream 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 snippets (auto-collected from DevExpress Examples) contain references to the SaveDocument(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-delete-pages-from-document/CS/PdfDeletePageExample/Program.cs#L22

        }
    pdfDocumentProcessor.SaveDocument("..\\..\\docs\\Deleted.pdf");
}

pdf-document-api-rotate-pdf-pages/CS/PdfPageRotationExample/Program.cs#L14

    }
    pdfDocumentProcessor.SaveDocument("..\\..\\docs\\Rotated.pdf");
}

pdf-document-api-import-acroform-data-from-xml/CS/ImportInteractiveForms/Program.cs#L16

    // Save the imported document.
    processor.SaveDocument("..\\..\\InteractiveForm.pdf");
}

pdf-document-api-add-bookmarks-to-document/CS/AddBookmarks/Program.cs#L21

    // Save the result document.
    processor.SaveDocument("..\\..\\Result.pdf");
}

pdf-document-api-add-graphics-to-landscape-and-portrait-pages/CS/CreateGraphics/Program.cs#L14

        AddGraphics(processor, "text", textBrush);
    processor.SaveDocument("..\\..\\RotatedDocumentWithGraphics.pdf");
}

VB.NET

pdf-document-api-flatten-interactive-form/VB/FlattenInteractiveForm/Program.vb#L16

    ' Show a message if the form field was not found in a document.
    processor.SaveDocument("..\..\Result1.pdf")
Else

pdf-document-api-remove-interactive-form-fields/VB/RemoveInteractiveForm/Program.vb#L15

    ' Save the modified document.
    processor.SaveDocument("..\..\Result1.pdf")
Else

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

    pdfDocumentProcessor.SaveDocument("..\..\docs\Deleted.pdf")
End Using

pdf-document-api-rotate-pdf-pages/VB/PdfPageRotationExample/Program.vb#L16

    pdfDocumentProcessor.SaveDocument("..\..\docs\Rotated.pdf")
End Using

pdf-document-api-import-acroform-data-from-xml/VB/ImportInteractiveForms/Program.vb#L14

    ' Save the imported document.
    processor.SaveDocument("..\..\InteractiveForm.pdf")
End Using