API Reference

Class

PdfEmbeddedFile

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Modifiers sealed

Describes a file embedded in a generated PDF and optionally associated with the document catalog.

Inheritance

  • Object
  • PdfEmbeddedFile

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

public PdfEmbeddedFile(String fileName, Byte[] data, String mimeType = null, PdfAssociatedFileRelationship relationship = Unspecified, String description = null, Nullable<DateTimeOffset> creationDate = null, Nullable<DateTimeOffset> modificationDate = null) #

Creates a PDF embedded file description.

Parameters

fileName System.String requiredposition: 0
data System.Byte[] requiredposition: 1
mimeType System.String = null optionalposition: 2
relationship OfficeIMO.Pdf.PdfAssociatedFileRelationship = Unspecified optionalposition: 3
description System.String = null optionalposition: 4
creationDate System.Nullable{System.DateTimeOffset} = null optionalposition: 5
modificationDate System.Nullable{System.DateTimeOffset} = null optionalposition: 6

Properties

public String FileName { get; set; } #

Embedded file name as exposed in the PDF name tree.

public Byte[] Data { get; } #

Embedded file bytes. The returned array is a defensive copy.

public String MimeType { get; set; } #

Optional MIME type, for example "application/xml".

public PdfAssociatedFileRelationship Relationship { get; set; } #

Associated-file relationship emitted as /AFRelationship.

public String Description { get; set; } #

Optional human-readable file description.

public Nullable<DateTimeOffset> CreationDate { get; set; } #

Optional embedded-file creation date.

public Nullable<DateTimeOffset> ModificationDate { get; set; } #

Optional embedded-file modification date.