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

C#

public string Description { get; set; }

VB.NET

Public Property Description As String

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

View Example

Program.cs

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

Program.vb

Imports DevExpress.Pdf
Imports System
Imports System.IO

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

Related GitHub Examples

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.

C#

how-to-attach-a-file-to-the-document-t304234/CS/AttachFile/Program.cs#L16

CreationDate = DateTime.Now,
Description = "This is my attach file.",
FileName = "MyAttach.txt",

VB.NET

how-to-attach-a-file-to-the-document-t304234/VB/AttachFile/Program.vb#L16

.CreationDate = Date.Now, _
.Description = "This is my attach file.", _
.FileName = "MyAttach.txt", _