com.aspose.words

Class PdfCustomPropertiesExport

  • java.lang.Object
    • com.aspose.words.PdfCustomPropertiesExport
public class PdfCustomPropertiesExport 
extends java.lang.Object

Utility class containing constants. Specifies the way Document.CustomDocumentProperties are exported to PDF file.

Example:

Shows how to export custom properties while converting a document to PDF.
Document doc = new Document();

doc.getCustomDocumentProperties().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.setCustomPropertiesExport(pdfCustomPropertiesExportMode);

doc.save(getArtifactsDir() + "PdfSaveOptions.CustomPropertiesExport.pdf", options);

Field Summary
static final intNONE = 0
No custom properties are exported.
static final intSTANDARD = 1
Custom 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".

static final intMETADATA = 2
Custom properties are Metadata.
 

    • Field Detail

      • NONE = 0

        public static final int NONE
        No custom properties are exported.
      • STANDARD = 1

        public static final int STANDARD
        Custom 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".

      • METADATA = 2

        public static final int METADATA
        Custom properties are Metadata.

        The namespace of exported properties in XMP packet is "custprops". Every property has an associated xml-element "custprops:Property1", "custprops:Property2" and so on. There is "rdf:Description" element inside property element. The description element has two elements "custprops:Name", containing custom property's name as a value of this xml-element, and "custprops:Value", containing custom property's value as value of this xml-element.