PdfDocumentProcessor.AttachFile(PdfFileAttachment) Method
Attaches a file to the PDF document.
Namespace: DevExpress.Pdf
Assembly: DevExpress.Docs.v20.2.dll
NuGet Package: DevExpress.Document.Processor
Declaration
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.
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");
}
}
}
}
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.