PdfEmbeddedFile Class

Class for a file embedded in PDF.

Inheritance Hierarchy

System.Object
  BitMiracle.Docotic.Pdf.PdfEmbeddedFile

Namespace:  BitMiracle.Docotic.Pdf
Assembly:  BitMiracle.Docotic.Pdf (in BitMiracle.Docotic.Pdf.dll)

Syntax

C#
public sealed class PdfEmbeddedFile
VB
Public NotInheritable Class PdfEmbeddedFile

The PdfEmbeddedFile type exposes the following members.

Properties

  NameDescription
Public propertyCreationDate
Gets or sets the date and time when the embedded file was created.
Public propertyId
Gets the identifier of this embedded file in this PdfDocument.
Public propertyMimeType
Gets or sets the MIME media type of the embedded file.
Public propertyModifiedDate
Gets or sets the date and time when the embedded file was last modified.
Public propertySize
Gets the size of the embedded file, in bytes.
Public propertyWriteWithoutCompression
Gets or sets the value indicating whether this file should be embedded as is, without being compressed.

Methods

  NameDescription
Public methodEquals (Inherited from Object.)
Public methodGetChecksum
Gets the MD5 checksum of the embedded file.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodReplaceWith(Byte[])
Replaces embedded file contents with the provided bytes.
Public methodReplaceWith(Stream)
Replaces embedded file contents with contents of the specified stream.
Public methodReplaceWith(String)
Replaces embedded file contents with contents of the specified file.
Public methodSave(Stream)
Saves the embedded file to the specified stream.
Public methodSave(String)
Saves the embedded file to the file with specified name.
Public methodToString (Inherited from Object.)

Remarks

File specifications (see PdfFileSpecification) ordinarily refer to files external to the PDF file in which they occur. When a PDF file is archived or transmitted, all external files it refers to must accompany it to preserve the file's integrity.

Embedded files address this problem by allowing the contents of referenced files to be embedded directly within the body of the PDF file. This makes the PDF file a self-contained unit that can be stored or transmitted as a single entity.

See Also