PdfDocumentProcessor.AttachFile(PdfFileAttachment) Method

Attaches a file to the PDF document.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Docs.v19.1.dll

Declaration

C#

public void AttachFile(
    PdfFileAttachment attachment
)

VB.NET

Public Sub AttachFile(
    attachment As PdfFileAttachment
)

Parameters

Name	Type	Description
attachment	PdfFileAttachment	A PdfFileAttachment object that contains settings to attach a file to the PDF document.

Remarks

Use this method to include an attachment to the PDF document using the necessary settings such as attachment data (PdfFileAttachment.Data), a file name (PdfFileAttachment.FileName), creation date (PdfFileAttachment.CreationDate), modification date (PdfFileAttachment.ModificationDate) and other settings.

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.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-attach-a-file-to-the-document-t304234

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AttachFile(PdfFileAttachment) 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-attach-file-to-document/CS/AttachFile/Program.cs#L14

// Attach a file to the PDF document.
processor.AttachFile(new PdfFileAttachment() {
    CreationDate = DateTime.Now,

VB.NET

pdf-document-api-attach-file-to-document/VB/AttachFile/Program.vb#L13

' 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.