PdfCustomPropertiesExport enumeration

PdfCustomPropertiesExport enumeration

Specifies the way Document.customDocumentProperties are exported to PDF file.

Members

NameDescription
NoneNo custom properties are exported.
StandardCustom properties are exported as entries in /Info dictionary. Custom properties with the following names are not exported: “Title”, “Author”, “Subject”, “Keywords”, “Creator”, “Producer”, “CreationDate”, “ModDate”, “Trapped”.
MetadataCustom properties are Metadata.

Examples

Shows how to export custom properties while converting a document to PDF.

let doc = new aw.Document();

doc.customDocumentProperties.add("Company", "My value");

// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
let options = new aw.Saving.PdfSaveOptions();

// Set the "CustomPropertiesExport" property to "PdfCustomPropertiesExport.None" to discard
// custom document properties as we save the document to .PDF.
// Set the "CustomPropertiesExport" property to "PdfCustomPropertiesExport.Standard"
// to preserve custom properties within the output PDF document.
// Set the "CustomPropertiesExport" property to "PdfCustomPropertiesExport.Metadata"
// to preserve custom properties in an XMP packet.
options.customPropertiesExport = pdfCustomPropertiesExportMode;

doc.save(base.artifactsDir + "PdfSaveOptions.customPropertiesExport.pdf", options);

See Also