Attachments

• Mar 20, 2020
• 2 minutes to read

File attachments are represented by an instance of the PdfFileAttachment class. You can specify the attachment creation date, description, and file name using PdfFileAttachment.CreationDate, PdfFileAttachment.Description, and PdfFileAttachment.FileName properties. You also need to specify the file data for the attachment using the PdfFileAttachment.Data property.

if required, you can specify additional properties of a file attachment such as a file’s MIME type and relationship using PdfFileAttachment.MimeType, and PdfFileAttachment.Relationship properties.

To attach a file to a document, call the PdfDocumentProcessor.AttachFile method.

To get an attachment, use the PdfDocument.FileAttachments property.

To delete an attachment, call the PdfDocumentProcessor.DeleteAttachment method.

Example

This example shows how to programmatically attach a file to the PDF document.

To do this:

• Create a PdfFileAttachment object;
• Specify the attachment creation date, description, and file name using PdfFileAttachment.CreationDate, PdfFileAttachment.Description, and PdfFileAttachment.FileName properties. To specify the data for the attachment, use the PdfFileAttachment.Data property;
• If required, you can specify additional properties of an attached file, for example, the file’s mime type and relationship using PdfFileAttachment.MimeType and PdfFileAttachment.Relationship properties, respectively.
• Call the PdfDocumentProcessor.AttachFile method with a file attachment object used as a parameter.
• Save the attachment to a document by calling the PdfDocumentProcessor.SaveDocument method.

View Example

Program.cs

using DevExpress.Pdf;
using System;
using System.IO;

namespace AttachFile {
    class Program {
        static void Main(string[] args) {

            using (PdfDocumentProcessor processor = new PdfDocumentProcessor()) {
                // Load a document.
                processor.LoadDocument("..\\..\\Document.pdf");

                // Attach a file to the PDF document. 
                processor.AttachFile(new PdfFileAttachment() {
                    CreationDate = DateTime.Now,
                    Description = "This is my attach file.",
                    FileName = "MyAttach.txt",
                    Data = File.ReadAllBytes("..\\..\\FileToAttach.txt")
                });

                // The attached document.
                processor.SaveDocument("..\\..\\Result.pdf");
            }
        }
    }
}

Program.vb

Imports DevExpress.Pdf
Imports System
Imports System.IO

Namespace AttachFile
    Friend Class Program
        Shared Sub Main(ByVal args() As String)

            Using processor As New PdfDocumentProcessor()
                ' Load a document.
                processor.LoadDocument("..\..\Document.pdf")

                ' Attach a file to the PDF document. 
                processor.AttachFile(New PdfFileAttachment() With { _
                    .CreationDate = Date.Now, _
                    .Description = "This is my attach file.", _
                    .FileName = "MyAttach.txt", _
                    .Data = File.ReadAllBytes("..\..\FileToAttach.txt") _
                })

                ' The attached document.
                processor.SaveDocument("..\..\Result.pdf")
            End Using
        End Sub
    End Class
End Namespace