Back to Devexpress

PdfViewerExtensions.Import(IPdfViewer, String, PdfFormDataFormat) Method

officefileapi-devexpress-dot-pdf-dot-pdfviewerextensions-dot-import-x28-devexpress-dot-pdf-dot-ipdfviewer-system-dot-string-devexpress-dot-pdf-dot-pdfformdataformat-x29.md

latest4.9 KB
Original Source

PdfViewerExtensions.Import(IPdfViewer, String, PdfFormDataFormat) Method

SECURITY-RELATED CONSIDERATIONS

Using file paths sourced from untrusted input may expose unauthorized files or allow unintended file access. Always validate and normalize all external paths to prevent path manipulation.

Imports interactive form data from the specified file with the specified form data format. This is an extension method.

Namespace : DevExpress.Pdf

Assembly : DevExpress.Docs.v25.2.dll

NuGet Package : DevExpress.Document.Processor

Declaration

csharp
public static void Import(
    this IPdfViewer viewer,
    string fileName,
    PdfFormDataFormat format
)
vb
<ExtensionAttribute>
Public Shared Sub Import(
    viewer As IPdfViewer,
    fileName As String,
    format As PdfFormDataFormat
)

Parameters

NameTypeDescription
viewerIPdfViewer

A PdfViewer or PdfViewerControl object that implements the IPdfViewer interface.

| | fileName | String |

A String, specifying the path to the file from which the interactive form data should be imported.

| | format | PdfFormDataFormat |

A PdfFormDataFormat enumeration value that lists formats for PDF form data values.

|

Remarks

See Export and Import Interactive Form Data (WinForms PDF Viewer) and Export and Import of Interactive Form Data (WPF PDF Viewer) topics to learn more.

Example

Important

The Universal Subscription or an additional Office File API Subscription is required to use this example in production code. Refer to the DevExpress Subscription page for pricing information.

This example demonstrates how to import AcroForm data (interactive form data) from XML format to a PDF document.

You can also import the AcroForm data from FDF, XFDF, and TXT formats, as described below.

To import interactive forms from XML format:

  • load an interactive forms document (e.g., from a file path), in which the data will be imported, into the PDF Viewer using the PdfViewer.LoadDocument method;
  • call one of the PdfViewerExtensions.Import overloaded methods, for example, with a specified XML file that contains imported data.

Note

You may need to add the DevExpress.Docs reference to your application to access the PdfViewer.Import extension methods.

csharp
using System.Windows.Forms;
using DevExpress.Pdf;

namespace ImportAcroForm {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();

            // Load a PDF document with AcroForm data.
            pdfViewer1.LoadDocument("..\\..\\InitialAcroForm.pdf");

            // Import the document from an XML format. 
            pdfViewer1.Import("..\\..\\FilledAcroForm.xml");

            // Save the imported document.
            pdfViewer1.SaveDocument("..\\..\\ImportedAcroForm.pdf");
        }
    }
}
vb
Imports System.Windows.Forms
Imports DevExpress.Pdf

Namespace ImportAcroForm
    Partial Public Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()

            ' Load a PDF document with AcroForm data.
            pdfViewer1.LoadDocument("..\..\InitialAcroForm.pdf")

            ' Import the document from an XML format. 
            pdfViewer1.Import("..\..\FilledAcroForm.xml")

            ' Save the imported document.
            pdfViewer1.SaveDocument("..\..\ImportedAcroForm.pdf")
        End Sub
    End Class
End Namespace

See Also

PdfViewerExtensions Class

PdfViewerExtensions Members

DevExpress.Pdf Namespace