Skip to main content
.NET Framework 4.5.2+

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.v22.1.Core.dll

Declaration

public string Description { get; set; }

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.

Example

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

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");
}

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Description property.

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.

See Also