FileSpecification Class

The file specification that includes the target file name in a standard format and information for specific file systems.

Namespace: DevExpress.Docs.Pdf

Assembly: DevExpress.Docs.Pdf.v26.1.dll

NuGet Package: DevExpress.Docs.Pdf

Declaration

C#

public class FileSpecification :
    ICloneable

VB.NET

Public Class FileSpecification
    Implements ICloneable

Related API Members

The following members return FileSpecification objects:

• FileAttachmentAnnotation.FileSpecification
• FileSpecification.Clone()
• FileSpecification.Clone(DocumentCloneContext)
• PdfNamespace.Schema
• RemoteGoToAction.FileSpecification

Example

How to: Create a File Attachment Annotation

The following code snippet creates a file attachment annotation and embeds a text file:

C#

using DevExpress.Docs.Pdf;
using System.Drawing;

using (PdfDocument pdfDocument =
    new PdfDocument(File.OpenRead(@"Document.pdf")))
{
    // Create a file attachment annotation
    FileAttachmentAnnotation annotation =
         new FileAttachmentAnnotation(
                 new RectangleF(50, 420, 20, 20));
    annotation.Content = "Project specification";
    annotation.Title = "John Smith";
    annotation.IconName = FileAttachmentAnnotationIconName.PaperClip;

    // Create a file data for the attachment
    FileSpecification fileSpecification = new FileSpecification();
    fileSpecification.FileName = "Specification.pdf";
    fileSpecification.FileData = File.ReadAllBytes(Path.Combine(Directory.GetCurrentDirectory(), "Specification.pdf"));
    fileSpecification.Description = "Project specification";

    annotation.FileSpecification = fileSpecification;

    // Add the annotation to the first page of the PDF document
    pdfDocument.Pages[0].Annotations.Add(annotation);

    pdfDocument.Save(File.OpenWrite(@"DocumentWithAnnotation.pdf"));
}

VB.NET

Import DevExpress.Docs.Pdf
Import System.Drawing

Using pdfDocument As New PdfDocument(File.OpenRead("Document.pdf"))
    ' Create a file attachment annotation
    Dim annotation As New FileAttachmentAnnotation(New RectangleF(50, 420, 20, 20))
    annotation.Content = "Project specification"
    annotation.Title = "John Smith"
    annotation.IconName = FileAttachmentAnnotationIconName.PaperClip

    ' Create a file data for the attachment
    Dim fileSpecification As New FileSpecification()
    fileSpecification.FileName = "Specification.pdf"
    fileSpecification.FileData = File.ReadAllBytes(Path.Combine(Directory.GetCurrentDirectory(), "Specification.pdf"))
    fileSpecification.Description = "Project specification"

    annotation.FileSpecification = fileSpecification

    ' Add the annotation to the first page of the PDF document
    pdfDocument.Pages(0).Annotations.Add(annotation)

    pdfDocument.Save(File.OpenWrite("DocumentWithAnnotation.pdf"))
End Using

Implements

ICloneable

Inheritance

Object

FileSpecification