PdfFileAttachment.Relationship Property

Gets or sets the relationship between the document and the attachment file.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v18.2.Core.dll

Declaration

C#

public PdfAssociatedFileRelationship Relationship { get; set; }

VB.NET

Public Property Relationship As PdfAssociatedFileRelationship

Property Value

Type	Description
PdfAssociatedFileRelationship	A PdfAssociatedFileRelationship enumeration value that specifies the relationship between the document and the attachment file.

Available values:

Name	Description
Source	The attached file has the original source material for the associated content.
Data	The attached file represents information used to derive a visual presentation (e.g. for a table or a graph).
Alternative	The attached file specification has an alternative representation of the content (e.g., audio).
Supplement	The attached file represents a supplemental representation of the original source or data.
EncryptedPayload	The file specification is an encrypted payload document that should be displayed to the user if the PDF Document Processor has the cryptographic filter needed to decrypt the document.
Unspecified	The relationship is unknown or does not match any relationship above.

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.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-attach-a-file-to-the-document-t304234

Program.cs

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

Program.vb

Imports DevExpress.Pdf
Imports System
Imports System.IO

Namespace AttachFile
    Friend Class Program
        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
    End Class
End Namespace