CustomPropertiesExport

PdfSaveOptions.CustomPropertiesExport property

Gets or sets a value determining the way CustomDocumentProperties are exported to PDF file.

public PdfCustomPropertiesExport CustomPropertiesExport { get; set; }

Remarks

Default value is None.

Metadata value is not supported when saving to PDF/A. Standard will be used instead for PDF/A-1 and PDF/A-2 and None for PDF/A-4.

Standard value is not supported when saving to PDF 2.0. Metadata will be used instead.

Examples

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

Document doc = new 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.
PdfSaveOptions options = new 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(ArtifactsDir + "PdfSaveOptions.CustomPropertiesExport.pdf", options);

See Also