PdfFileAttachment.Description Property
Specifies the description for the attached file shown in the Attachments panel of a PDF Viewer.
Namespace: DevExpress.Pdf
Assembly: DevExpress.Pdf.v20.2.Core.dll
Declaration
Property Value
| Type | Description |
|---|---|
| String | A string that is an attached file description. |
Remarks
Use the Description property to specify a description for the attached file, which helps to differentiate between similar files in the Attachments panel of the PDF Viewer.
Examples
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");
}
}
}
}
See Also
Feedback