PdfEmbeddedFileOptions Class

The attributes of a file embedded in a document (PdfEmbeddedFileCollection.Add, PdfAnnotationCollection.AddFileAttachment).

public sealed class PdfEmbeddedFileOptions

Constructors

NameDescription
PdfEmbeddedFileOptions()

PdfEmbeddedFileOptions()

public PdfEmbeddedFileOptions()

No documentation is available.

Properties

NameDescription
CreationDateGets the date the file was created (/Params /CreationDate), or null to leave it out.
DescriptionGets the description of the file (/Desc), which PDF/UA-2 requires for the files of the document.
MimeTypeGets the MIME type of the file (/Subtype of the embedded file stream), such as text/csv. The default, null, writes application/octet-stream: PDF/A-3 and PDF/A-4 need a MIME type.
ModificationDateGets the date the file was last modified (/Params /ModDate), or null to leave it out.
RelationshipGets how the file relates to the content of the document (/AFRelationship). The default is PdfAssociatedFileRelationship.Unspecified.

Gets the date the file was created (/Params /CreationDate), or null to leave it out.

public DateTimeOffset? CreationDate { get; init; }

Property value

DateTimeOffset?

Gets the description of the file (/Desc), which PDF/UA-2 requires for the files of the document.

public string? Description { get; init; }

Property value

string?

Gets the MIME type of the file (/Subtype of the embedded file stream), such as text/csv. The default, null, writes application/octet-stream: PDF/A-3 and PDF/A-4 need a MIME type.

public string? MimeType { get; init; }

Property value

string?

Gets the date the file was last modified (/Params /ModDate), or null to leave it out.

public DateTimeOffset? ModificationDate { get; init; }

Property value

DateTimeOffset?

Remarks

The library never writes a date it is not given: the output of a save depends only on the document.

Gets how the file relates to the content of the document (/AFRelationship). The default is PdfAssociatedFileRelationship.Unspecified.

public PdfAssociatedFileRelationship Relationship { get; init; }