API Reference
Class
PdfEmbeddedFile
Describes a file embedded in a generated PDF and associated with the document catalog or a canvas structure element.
Inheritance
- Object
- PdfEmbeddedFile
Usage
Explore 9 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 3
- Property PdfAttachmentEditSession.Attachments
- Property PdfCanvasStructureOptions.AssociatedFiles
- Property PdfOptions.EmbeddedFiles
Accepted by parameters 6
- Method PdfAttachmentEditSession.Add
- Method PdfAttachmentEditSession.Replace
- Method PdfCanvasStructureOptions.AddAssociatedFile
- Method PdfDocumentAttachments.Add
- Method PdfDocumentAttachments.Replace
- Method PdfOptions.AddEmbeddedFile
Constructors
public PdfEmbeddedFile(String fileName, Byte[] data, String? mimeType = null, PdfAssociatedFileRelationship relationship = Unspecified, String? description = null, DateTimeOffset? creationDate = null, DateTimeOffset? modificationDate = null) #Creates a PDF embedded file description.
Parameters
- fileName System.String
- data System.Byte[]
- mimeType System.String? = null
- relationship OfficeIMO.Pdf.PdfAssociatedFileRelationship = Unspecified
- description System.String? = null
- creationDate System.DateTimeOffset? = null
- modificationDate System.DateTimeOffset? = null
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
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 DateTimeOffset? CreationDate { get; set; } #Optional embedded-file creation date.
public DateTimeOffset? ModificationDate { get; set; } #Optional embedded-file modification date.