com.aspose.words

Class PdfSaveOptions

  • All Implemented Interfaces:
    java.lang.Cloneable
    public class PdfSaveOptions 
    extends FixedPageSaveOptions

Can be used to specify additional options when saving a document into the SaveFormat.PDF format.

Example:

Shows how to change image color with saving options property.
Document doc = new Document(getMyDir() + "Images.docx");

// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
// Set the "ColorMode" property to "Grayscale" to render all images from the document in black and white.
// The size of the output document may be larger with this setting.
// Set the "ColorMode" property to "Normal" to render all images in color.
PdfSaveOptions pdfSaveOptions = new PdfSaveOptions(); { pdfSaveOptions.setColorMode(colorMode); }

doc.save(getArtifactsDir() + "PdfSaveOptions.ColorRendering.pdf", pdfSaveOptions);

Example:

Shows how to apply text compression when saving a document to PDF.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

for (int i = 0; i < 100; i++)
    builder.writeln("Lorem ipsum dolor sit amet, consectetur adipiscing elit, " +
                    "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");

// 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 "TextCompression" property to "PdfTextCompression.None" to not apply any
// compression to text when we save the document to PDF.
// Set the "TextCompression" property to "PdfTextCompression.Flate" to apply ZIP compression
// to text when we save the document to PDF. The larger the document, the bigger the impact that this will have.
options.setTextCompression(pdfTextCompression);

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

Example:

Shows how to convert a whole document to PDF with three levels in the document outline.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert headings of levels 1 to 5.
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);

Assert.assertTrue(builder.getParagraphFormat().isHeading());

builder.writeln("Heading 1");

builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);

builder.writeln("Heading 1.1");
builder.writeln("Heading 1.2");

builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_3);

builder.writeln("Heading 1.2.1");
builder.writeln("Heading 1.2.2");

builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_4);

builder.writeln("Heading 1.2.2.1");
builder.writeln("Heading 1.2.2.2");

builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_5);

builder.writeln("Heading 1.2.2.2.1");
builder.writeln("Heading 1.2.2.2.2");

// 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();

// The output PDF document will contain an outline, which is a table of contents that lists headings in the document body.
// Clicking on an entry in this outline will take us to the location of its respective heading.
// Set the "HeadingsOutlineLevels" property to "4" to exclude all headings whose levels are above 4 from the outline.
options.getOutlineOptions().setHeadingsOutlineLevels(4);

// If an outline entry has subsequent entries of a higher level inbetween itself and the next entry of the same or lower level,
// an arrow will appear to the left of the entry. This entry is the "owner" of a number of such "sub-entries".
// In our document, the outline entries from the 5th heading level are sub-entries of the second 4th level outline entry,
// the 4th and 5th heading level entries are sub-entries of the second 3rd level entry, and so on. 
// In the outline, we can click on the arrow of the "owner" entry to collapse/expand all of its sub-entries.
// Set the "ExpandedOutlineLevels" property to "2" to automatically expand all heading level 2 and lower outline entries
// and collapse all level and 3 and higher entries when we open the document. 
options.getOutlineOptions().setExpandedOutlineLevels(2);

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

Constructor Summary
PdfSaveOptions()
Initializes a new instance of this class that can be used to save a document in the SaveFormat.PDF format.
 
Property Getters/Setters Summary
booleangetAdditionalTextPositioning()
void
           A flag specifying whether to write additional text positioning operators or not.
booleangetAllowEmbeddingPostScriptFonts()
void
           Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false.
intgetColorMode()
void
setColorMode(intvalue)
           Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant.
intgetCompliance()
void
setCompliance(intvalue)
           Specifies the PDF standards compliance level for output documents. The value of the property is PdfCompliance integer constant.
booleangetCreateNoteHyperlinks()
void
           Specifies whether to convert footnote/endnote references in main text story into active hyperlinks. When clicked the hyperlink will lead to the corresponding footnote/endnote. Default is false.
intgetCustomPropertiesExport()
void
           Gets or sets a value determining the way Document.CustomDocumentProperties are exported to PDF file. Default value is PdfCustomPropertiesExport.NONE. The value of the property is PdfCustomPropertiesExport integer constant.
java.lang.StringgetDefaultTemplate()
void
setDefaultTemplate(java.lang.Stringvalue)
           Gets or sets path to default template (including filename). Default value for this property is empty string.
PdfDigitalSignatureDetailsgetDigitalSignatureDetails()
void
           Gets or sets the details for signing the output PDF document.
booleangetDisplayDocTitle()
void
setDisplayDocTitle(booleanvalue)
           A flag specifying whether the window’s title bar should display the document title taken from the Title entry of the document information dictionary.
intgetDml3DEffectsRenderingMode()
void
           Gets or sets a value determining how 3D effects are rendered. The value of the property is Dml3DEffectsRenderingMode integer constant.
intgetDmlEffectsRenderingMode()
void
           Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant.
intgetDmlRenderingMode()
void
           Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant.
DownsampleOptionsgetDownsampleOptions()
void
           Allows to specify downsample options.
booleangetEmbedFullFonts()
void
setEmbedFullFonts(booleanvalue)
           Controls how fonts are embedded into the resulting PDF documents.
PdfEncryptionDetailsgetEncryptionDetails()
void
           Gets or sets the details for encrypting the output PDF document.
booleangetEscapeUri()
void
setEscapeUri(booleanvalue)
          Deprecated. A flag specifying whether URI should be escaped before writing.
booleangetExportDocumentStructure()
void
           Gets or sets a value determining whether or not to export document structure.
intgetFontEmbeddingMode()
void
           Specifies the font embedding mode. The value of the property is PdfFontEmbeddingMode integer constant.
intgetHeaderFooterBookmarksExportMode()
void
           Determines how bookmarks in headers/footers are exported. The value of the property is HeaderFooterBookmarksExportMode integer constant.
intgetImageColorSpaceExportMode()
void
           Specifies how the color space will be selected for the images in PDF document. The value of the property is PdfImageColorSpaceExportMode integer constant.
intgetImageCompression()
void
           Specifies compression type to be used for all images in the document. The value of the property is PdfImageCompression integer constant.
booleangetInterpolateImages()
void
setInterpolateImages(booleanvalue)
           A flag indicating whether image interpolation shall be performed by a conforming reader. When false is specified, the flag is not written to the output document and the default behaviour of reader is used instead.
intgetJpegQuality()
void
setJpegQuality(intvalue)
           Gets or sets a value determining the quality of the JPEG images inside PDF document.
booleangetMemoryOptimization()
void
setMemoryOptimization(booleanvalue)
           Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false.
MetafileRenderingOptionsgetMetafileRenderingOptions()
void
           Allows to specify metafile rendering options.
intgetNumeralFormat()
void
           Gets or sets NumeralFormat used for rendering of numerals. European numerals are used by default. The value of the property is NumeralFormat integer constant.
booleangetOpenHyperlinksInNewWindow()
void
           Gets or sets a value determining whether hyperlinks in the output Pdf document are forced to be opened in a new window (or tab) of a browser.
booleangetOptimizeOutput()
void
setOptimizeOutput(booleanvalue)
           Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false.
OutlineOptionsgetOutlineOptions()
Allows to specify outline options.
intgetPageMode()
void
setPageMode(intvalue)
           Specifies how the PDF document should be displayed when opened in the PDF reader. The value of the property is PdfPageMode integer constant.
IPageSavingCallbackgetPageSavingCallback()
void
           Allows to control how separate pages are saved when a document is exported to fixed page format.
PageSetgetPageSet()
void
           Gets or sets the pages to render. Default is all the pages in the document.
booleangetPreblendImages()
void
setPreblendImages(booleanvalue)
           Gets or sets a value determining whether or not to preblend transparent images with black background color.
booleangetPreserveFormFields()
void
setPreserveFormFields(booleanvalue)
           Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text. Default is false.
booleangetPrettyFormat()
void
setPrettyFormat(booleanvalue)
           When true, pretty formats output where applicable. Default value is false.
intgetSaveFormat()
void
setSaveFormat(intvalue)
           Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.PDF. The value of the property is SaveFormat integer constant.
java.lang.StringgetTempFolder()
void
setTempFolder(java.lang.Stringvalue)
           Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is null and no temporary files are used.
intgetTextCompression()
void
           Specifies compression type to be used for all textual content in the document. The value of the property is PdfTextCompression integer constant.
booleangetUpdateFields()
void
setUpdateFields(booleanvalue)
           Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true.
booleangetUpdateLastPrintedProperty()
void
           Gets or sets a value determining whether the BuiltInDocumentProperties.LastPrinted property is updated before saving.
booleangetUpdateLastSavedTimeProperty()
void
           Gets or sets a value determining whether the BuiltInDocumentProperties.LastSavedTime property is updated before saving.
booleangetUpdateSdtContent()
void
setUpdateSdtContent(booleanvalue)
           Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
booleangetUseAntiAliasing()
void
setUseAntiAliasing(booleanvalue)
           Gets or sets a value determining whether or not to use anti-aliasing for rendering.
booleangetUseBookFoldPrintingSettings()
void
           Gets or sets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via PageSetup.MultiplePages.
booleangetUseCoreFonts()
void
setUseCoreFonts(booleanvalue)
           Gets or sets a value determining whether or not to substitute TrueType fonts Arial, Times New Roman, Courier New and Symbol with core PDF Type 1 fonts.
booleangetUseHighQualityRendering()
void
           Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
intgetZoomBehavior()
void
setZoomBehavior(intvalue)
           Gets or sets a value determining what type of zoom should be applied when a document is opened with a PDF viewer. The value of the property is PdfZoomBehavior integer constant.
intgetZoomFactor()
void
setZoomFactor(intvalue)
           Gets or sets a value determining zoom factor (in percentages) for a document.
 
Method Summary
PdfSaveOptionsdeepClone()
Creates a deep clone of this object.
booleanequals(java.lang.Object obj)
Determines whether the specified object is equal in value to the current object.
 

    • Constructor Detail

      • PdfSaveOptions

        public PdfSaveOptions()
        Initializes a new instance of this class that can be used to save a document in the SaveFormat.PDF format.

        Example:

        Shows how to enable or disable subsetting when embedding fonts while rendering a document to PDF.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getFont().setName("Arial");
        builder.writeln("Hello world!");
        builder.getFont().setName("Arvo");
        builder.writeln("The quick brown fox jumps over the lazy dog.");
        
        // Configure our font sources to ensure that we have access to both the fonts in this document.
        FontSourceBase[] originalFontsSources = FontSettings.getDefaultInstance().getFontsSources();
        FolderFontSource folderFontSource = new FolderFontSource(getFontsDir(), true);
        FontSettings.getDefaultInstance().setFontsSources(new FontSourceBase[] { originalFontsSources[0], folderFontSource });
        
        // 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();
        
        // Since our document contains a custom font, embedding in the output document may be desirable.
        // Set the "EmbedFullFonts" property to "true" to embed every glyph of every embedded font in the output PDF.
        // The document's size may become very large, but we will have full use of all fonts if we edit the PDF.
        // Set the "EmbedFullFonts" property to "false" to apply subsetting to fonts, saving only the glyphs
        // that the document is using. The file will be considerably smaller,
        // but we may need access to any custom fonts if we edit the document.
        options.setEmbedFullFonts(embedFullFonts);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.EmbedFullFonts.pdf", options);
        
        // Restore the original font sources.
        FontSettings.getDefaultInstance().setFontsSources(originalFontsSources);
    • Property Getters/Setters Detail

      • getAdditionalTextPositioning/setAdditionalTextPositioning

        public boolean getAdditionalTextPositioning() / public void setAdditionalTextPositioning(boolean value)
        
        A flag specifying whether to write additional text positioning operators or not.

        If true, additional text positioning operators are written to the output PDF. This may help to overcome issues with inaccurate text positioning with some printers. The downside is the increased PDF document size.

        The default value is false.

        Example:

        Show how to write additional text positioning operators.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        
        // 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 saveOptions = new PdfSaveOptions();
        saveOptions.setTextCompression(PdfTextCompression.NONE);
        
        // Set the "AdditionalTextPositioning" property to "true" to attempt to fix incorrect
        // element positioning in the output PDF, should there be any, at the cost of increased file size.
        // Set the "AdditionalTextPositioning" property to "false" to render the document as usual.
            saveOptions.setAdditionalTextPositioning(applyAdditionalTextPositioning);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.AdditionalTextPositioning.pdf", saveOptions);
      • getAllowEmbeddingPostScriptFonts/setAllowEmbeddingPostScriptFonts

        public boolean getAllowEmbeddingPostScriptFonts() / public void setAllowEmbeddingPostScriptFonts(boolean value)
        
        Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false.

        Note, Word does not embed PostScript fonts, but can open documents with embedded fonts of this type.

        This option only works when FontInfoCollection.EmbedTrueTypeFonts of the DocumentBase.FontInfos property is set to true.

      • getColorMode/setColorMode

        public int getColorMode() / public void setColorMode(int value)
        
        Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant.The default value is ColorMode.NORMAL.

        Example:

        Shows how to change image color with saving options property.
        Document doc = new Document(getMyDir() + "Images.docx");
        
        // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
        // to modify how that method converts the document to .PDF.
        // Set the "ColorMode" property to "Grayscale" to render all images from the document in black and white.
        // The size of the output document may be larger with this setting.
        // Set the "ColorMode" property to "Normal" to render all images in color.
        PdfSaveOptions pdfSaveOptions = new PdfSaveOptions(); { pdfSaveOptions.setColorMode(colorMode); }
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.ColorRendering.pdf", pdfSaveOptions);
      • getCompliance/setCompliance

        public int getCompliance() / public void setCompliance(int value)
        
        Specifies the PDF standards compliance level for output documents. The value of the property is PdfCompliance integer constant.

        Default is PdfCompliance.PDF_17.

        Example:

        Shows how to set the PDF standards compliance level of saved PDF documents.
        Document doc = new Document(getMyDir() + "Images.docx");
        
        // 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 saveOptions = new PdfSaveOptions();
        
        // Set the "Compliance" property to "PdfCompliance.PdfA1b" to comply with the "PDF/A-1b" standard,
        // which aims to preserve the visual appearance of the document as Aspose.Words convert it to PDF.
        // Set the "Compliance" property to "PdfCompliance.Pdf17" to comply with the "1.7" standard.
        // Set the "Compliance" property to "PdfCompliance.PdfA1a" to comply with the "PDF/A-1a" standard,
        // which complies with "PDF/A-1b" as well as preserving the document structure of the original document.
        // This helps with making documents searchable, but may significantly increase the size of already large documents.
        saveOptions.setCompliance(pdfCompliance);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.Compliance.pdf", saveOptions);
      • getCreateNoteHyperlinks/setCreateNoteHyperlinks

        public boolean getCreateNoteHyperlinks() / public void setCreateNoteHyperlinks(boolean value)
        
        Specifies whether to convert footnote/endnote references in main text story into active hyperlinks. When clicked the hyperlink will lead to the corresponding footnote/endnote. Default is false.

        Example:

        Shows how to make footnotes and endnotes function as hyperlinks.
        Document doc = new Document(getMyDir() + "Footnotes and endnotes.docx");
        
        // 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 "CreateNoteHyperlinks" property to "true" to turn all footnote/endnote symbols
        // in the text act as links that, upon clicking, take us to their respective footnotes/endnotes.
        // Set the "CreateNoteHyperlinks" property to "false" not to have footnote/endnote symbols link to anything.
        options.setCreateNoteHyperlinks(createNoteHyperlinks);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.NoteHyperlinks.pdf", options);
      • getCustomPropertiesExport/setCustomPropertiesExport

        public int getCustomPropertiesExport() / public void setCustomPropertiesExport(int value)
        
        Gets or sets a value determining the way Document.CustomDocumentProperties are exported to PDF file. Default value is PdfCustomPropertiesExport.NONE. The value of the property is PdfCustomPropertiesExport integer constant.

        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);
      • getDefaultTemplate/setDefaultTemplate

        public java.lang.String getDefaultTemplate() / public void setDefaultTemplate(java.lang.String value)
        
        Gets or sets path to default template (including filename). Default value for this property is empty string. If specified, this path is used to load template when Document.AutomaticallyUpdateStyles is true, but Document.AttachedTemplate is empty.

        Example:

        Shows how to set a default template for documents that do not have attached templates.
        Document doc = new Document();
        
        // Enable automatic style updating, but do not attach a template document.
        doc.setAutomaticallyUpdateStyles(true);
        
        Assert.assertEquals("", doc.getAttachedTemplate());
        
        // Since there is no template document, the document had nowhere to track style changes.
        // Use a SaveOptions object to automatically set a template
        // if a document that we are saving does not have one.
        SaveOptions options = SaveOptions.createSaveOptions("Document.DefaultTemplate.docx");
        options.setDefaultTemplate(getMyDir() + "Business brochure.dotx");
        
        doc.save(getArtifactsDir() + "Document.DefaultTemplate.docx", options);
      • getDigitalSignatureDetails/setDigitalSignatureDetails

        public PdfDigitalSignatureDetails getDigitalSignatureDetails() / public void setDigitalSignatureDetails(PdfDigitalSignatureDetails value)
        
        Gets or sets the details for signing the output PDF document.

        At the moment digitally signing PDF documents is only available on .NET 2.0 or higher.

        The default value is null and the output document will not be signed. When this property is set to a valid PdfDigitalSignatureDetails object, then the output PDF document will be digitally signed.

        Example:

        Shows how to sign a generated PDF document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.writeln("Contents of signed PDF.");
        
        CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw");
        
        // 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();
        
        // Configure the "DigitalSignatureDetails" object of the "SaveOptions" object to
        // digitally sign the document as we render it with the "Save" method.
        Date signingTime = new Date();
        options.setDigitalSignatureDetails(new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "Aspose Office", signingTime));
        options.getDigitalSignatureDetails().setHashAlgorithm(PdfDigitalSignatureHashAlgorithm.SHA_256);
        
        Assert.assertEquals(options.getDigitalSignatureDetails().getReason(), "Test Signing");
        Assert.assertEquals(options.getDigitalSignatureDetails().getLocation(), "Aspose Office");
        Assert.assertEquals(options.getDigitalSignatureDetails().getSignatureDate(), signingTime);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.PdfDigitalSignature.pdf", options);
      • getDisplayDocTitle/setDisplayDocTitle

        public boolean getDisplayDocTitle() / public void setDisplayDocTitle(boolean value)
        
        A flag specifying whether the window’s title bar should display the document title taken from the Title entry of the document information dictionary. If false, the title bar should instead display the name of the PDF file containing the document.

        The default value is false.

        Example:

        Shows how to display the title of the document as the title bar.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.writeln("Hello world!");
        
        doc.getBuiltInDocumentProperties().setTitle("Windows bar pdf title");
        
        // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
        // to modify how that method converts the document to .PDF.
        // Set the "DisplayDocTitle" to "true" to get some PDF readers, such as Adobe Acrobat Pro,
        // to display the value of the document's "Title" built-in property in the tab that belongs to this document.
        // Set the "DisplayDocTitle" to "false" to get such readers to display the document's filename.
        PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
        {
            pdfSaveOptions.setDisplayDocTitle(displayDocTitle);
        }
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.DocTitle.pdf", pdfSaveOptions);
      • getDml3DEffectsRenderingMode/setDml3DEffectsRenderingMode

        public int getDml3DEffectsRenderingMode() / public void setDml3DEffectsRenderingMode(int value)
        
        Gets or sets a value determining how 3D effects are rendered. The value of the property is Dml3DEffectsRenderingMode integer constant. The default value is Dml3DEffectsRenderingMode.BASIC.
      • getDmlEffectsRenderingMode/setDmlEffectsRenderingMode

        public int getDmlEffectsRenderingMode() / public void setDmlEffectsRenderingMode(int value)
        
        Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant. The default value is DmlEffectsRenderingMode.SIMPLIFIED.

        This property is used when the document is exported to fixed page formats.

        If Compliance is set to PdfCompliance.PDF_A_1_A or PdfCompliance.PDF_A_1_B, property always returns DmlEffectsRenderingMode.NONE.

        Example:

        Shows how to configure the rendering quality of DrawingML effects in a document as we save it to PDF.
        Document doc = new Document(getMyDir() + "DrawingML shape effects.docx");
        
        // 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 "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.None" to discard all DrawingML effects.
        // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Simplified"
        // to render a simplified version of DrawingML effects.
        // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Fine" to
        // render DrawingML effects with more accuracy and also with more processing cost.
        options.setDmlEffectsRenderingMode(effectsRenderingMode);
        
        Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode());
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options);
      • getDmlRenderingMode/setDmlRenderingMode

        public int getDmlRenderingMode() / public void setDmlRenderingMode(int value)
        
        Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant. The default value is DmlRenderingMode.FALLBACK.

        This property is used when the document is exported to fixed page formats.

        Example:

        Shows how to render fallback shapes when saving to PDF.
        Document doc = new Document(getMyDir() + "DrawingML shape fallbacks.docx");
        
        // 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 "DmlRenderingMode" property to "DmlRenderingMode.Fallback"
        // to substitute DML shapes with their fallback shapes.
        // Set the "DmlRenderingMode" property to "DmlRenderingMode.DrawingML"
        // to render the DML shapes themselves.
        options.setDmlRenderingMode(dmlRenderingMode);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLFallback.pdf", options);

        Example:

        Shows how to configure the rendering quality of DrawingML effects in a document as we save it to PDF.
        Document doc = new Document(getMyDir() + "DrawingML shape effects.docx");
        
        // 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 "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.None" to discard all DrawingML effects.
        // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Simplified"
        // to render a simplified version of DrawingML effects.
        // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Fine" to
        // render DrawingML effects with more accuracy and also with more processing cost.
        options.setDmlEffectsRenderingMode(effectsRenderingMode);
        
        Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode());
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options);
      • getDownsampleOptions/setDownsampleOptions

        public DownsampleOptions getDownsampleOptions() / public void setDownsampleOptions(DownsampleOptions value)
        
        Allows to specify downsample options.

        Example:

        Shows how to change the resolution of images in the PDF document.
        Document doc = new Document(getMyDir() + "Images.docx");
        
        // 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();
        
        // By default, Aspose.Words downsample all images in a document that we save to PDF to 220 ppi.
        Assert.assertTrue(options.getDownsampleOptions().getDownsampleImages());
        Assert.assertEquals(220, options.getDownsampleOptions().getResolution());
        Assert.assertEquals(0, options.getDownsampleOptions().getResolutionThreshold());
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.Default.pdf", options);
        
        // Set the "Resolution" property to "36" to downsample all images to 36 ppi.
        options.getDownsampleOptions().setResolution(36);
        
        // Set the "ResolutionThreshold" property to only apply the downsampling to
        // images with a resolution that is above 128 ppi.
        options.getDownsampleOptions().setResolutionThreshold(128);
        
        // Only the first two images from the document will be downsampled at this stage.
        doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.LowerResolution.pdf", options);
      • getEmbedFullFonts/setEmbedFullFonts

        public boolean getEmbedFullFonts() / public void setEmbedFullFonts(boolean value)
        
        Controls how fonts are embedded into the resulting PDF documents.

        The default value is false, which means the fonts are subsetted before embedding. Subsetting is useful if you want to keep the output file size smaller. Subsetting removes all unused glyphs from a font.

        When this value is set to true, a complete font file is embedded into PDF without subsetting. This will result in larger output files, but can be a useful option when you want to edit the resulting PDF later (e.g. add more text).

        Some fonts are large (several megabytes) and embedding them without subsetting will result in large output documents.

        Example:

        Shows how to enable or disable subsetting when embedding fonts while rendering a document to PDF.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getFont().setName("Arial");
        builder.writeln("Hello world!");
        builder.getFont().setName("Arvo");
        builder.writeln("The quick brown fox jumps over the lazy dog.");
        
        // Configure our font sources to ensure that we have access to both the fonts in this document.
        FontSourceBase[] originalFontsSources = FontSettings.getDefaultInstance().getFontsSources();
        FolderFontSource folderFontSource = new FolderFontSource(getFontsDir(), true);
        FontSettings.getDefaultInstance().setFontsSources(new FontSourceBase[] { originalFontsSources[0], folderFontSource });
        
        // 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();
        
        // Since our document contains a custom font, embedding in the output document may be desirable.
        // Set the "EmbedFullFonts" property to "true" to embed every glyph of every embedded font in the output PDF.
        // The document's size may become very large, but we will have full use of all fonts if we edit the PDF.
        // Set the "EmbedFullFonts" property to "false" to apply subsetting to fonts, saving only the glyphs
        // that the document is using. The file will be considerably smaller,
        // but we may need access to any custom fonts if we edit the document.
        options.setEmbedFullFonts(embedFullFonts);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.EmbedFullFonts.pdf", options);
        
        // Restore the original font sources.
        FontSettings.getDefaultInstance().setFontsSources(originalFontsSources);
      • getEncryptionDetails/setEncryptionDetails

        public PdfEncryptionDetails getEncryptionDetails() / public void setEncryptionDetails(PdfEncryptionDetails value)
        
        Gets or sets the details for encrypting the output PDF document.

        The default value is null and the output document will not be encrypted. When this property is set to a valid PdfEncryptionDetails object, then the output PDF document will be encrypted.

        Note that encryption cannot be used when PDF/A compliance is set as this compliance does not permit encryption.");

        Example:

        Shows how to set permissions on a saved PDF document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.writeln("Hello world!");
        
        PdfEncryptionDetails encryptionDetails =
            new PdfEncryptionDetails("password", "", PdfEncryptionAlgorithm.RC_4_128);
        
        // Start by disallowing all permissions.
        encryptionDetails.setPermissions(PdfPermissions.DISALLOW_ALL);
        
        // Extend permissions to allow the editing of annotations.
        encryptionDetails.setPermissions(PdfPermissions.MODIFY_ANNOTATIONS | PdfPermissions.DOCUMENT_ASSEMBLY);
        
        // 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 saveOptions = new PdfSaveOptions();
        
        // Enable encryption via the "EncryptionDetails" property.
        saveOptions.setEncryptionDetails(encryptionDetails);
        
        // When we open this document, we will need to provide the password before accessing its contents.
        doc.save(getArtifactsDir() + "PdfSaveOptions.EncryptionPermissions.pdf", saveOptions);
      • getEscapeUri/setEscapeUri

        @Deprecated
        public boolean getEscapeUri() / public void setEscapeUri(boolean value)
        
        Deprecated. A flag specifying whether URI should be escaped before writing. Note that if this option is set to false hyperlinks are written "as is", so valid (escaped) URI should be provided in document's model.

        The default value is true.

        Example:

        Shows how to escape hyperlinks in the document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.insertHyperlink("Testlink", uri, false);
        
        // 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 "EscapeUri" property to "true" if links in the document contain characters,
        // such as the blank space, that we need to replace with escape sequences, such as "%20".
        // Set the "EscapeUri" property to "false" if we are sure that this document's links
        // do not need any such escape character substitution.
        options.setEscapeUri(isEscaped);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.EscapedUri.pdf", options);
      • getExportDocumentStructure/setExportDocumentStructure

        public boolean getExportDocumentStructure() / public void setExportDocumentStructure(boolean value)
        
        Gets or sets a value determining whether or not to export document structure.

        This value is ignored when saving to PDF/A-1a because document structure is required for this compliance.

        Note that exporting the document structure significantly increases the memory consumption, especially for the large documents.

        Example:

        Shows how to preserve document structure elements, which can assist in programmatically interpreting our document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1"));
        builder.writeln("Hello world!");
        builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
        builder.write(
            "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
        
        // 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 "ExportDocumentStructure" property to "true" to make the document structure, such tags, available via the
        // "Content" navigation pane of Adobe Acrobat at the cost of increased file size.
        // Set the "ExportDocumentStructure" property to "false" to not export the document structure.
        options.setExportDocumentStructure(exportDocumentStructure);
        
        // Suppose we export document structure while saving this document. In that case,
        // we can open it using Adobe Acrobat and find tags for elements such as the heading
        // and the next paragraph via "View" -> "Show/Hide" -> "Navigation panes" -> "Tags".
        doc.save(getArtifactsDir() + "PdfSaveOptions.ExportDocumentStructure.pdf", options);
      • getFontEmbeddingMode/setFontEmbeddingMode

        public int getFontEmbeddingMode() / public void setFontEmbeddingMode(int value)
        
        Specifies the font embedding mode. The value of the property is PdfFontEmbeddingMode integer constant.

        The default value is PdfFontEmbeddingMode.EMBED_ALL.

        This setting works only for the text in ANSI (Windows-1252) encoding. If the document contains non-ANSI text then corresponding fonts will be embedded regardless of this setting.

        Note that when saving to PDF/A this option must be set to PdfFontEmbeddingMode.EMBED_ALL as all fonts must be embedded in the PDF file.

        Example:

        Shows how to set Aspose.Words to skip embedding Arial and Times New Roman fonts into a PDF document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // "Arial" is a standard font, and "Courier New" is a nonstandard font.
        builder.getFont().setName("Arial");
        builder.writeln("Hello world!");
        builder.getFont().setName("Courier New");
        builder.writeln("The quick brown fox jumps over the lazy dog.");
        
        // 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 "EmbedFullFonts" property to "true" to embed every glyph of every embedded font in the output PDF.
        options.setEmbedFullFonts(true);
        
        // Set the "FontEmbeddingMode" property to "EmbedAll" to embed all fonts in the output PDF.
        // Set the "FontEmbeddingMode" property to "EmbedNonstandard" to only allow nonstandard fonts' embedding in the output PDF.
        // Set the "FontEmbeddingMode" property to "EmbedNone" to not embed any fonts in the output PDF.
        options.setFontEmbeddingMode(pdfFontEmbeddingMode);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.EmbedWindowsFonts.pdf", options);
      • getHeaderFooterBookmarksExportMode/setHeaderFooterBookmarksExportMode

        public int getHeaderFooterBookmarksExportMode() / public void setHeaderFooterBookmarksExportMode(int value)
        
        Determines how bookmarks in headers/footers are exported. The value of the property is HeaderFooterBookmarksExportMode integer constant.

        The default value is HeaderFooterBookmarksExportMode.ALL.

        This property is used in conjunction with the OutlineOptions option.

        Example:

        Shows to process bookmarks in headers/footers in a document that we are rendering to PDF.
        Document doc = new Document(getMyDir() + "Bookmarks in headers and footers.docx");
        
        // 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 saveOptions = new PdfSaveOptions();
        
        // Set the "PageMode" property to "PdfPageMode.UseOutlines" to display the outline navigation pane in the output PDF.
        saveOptions.setPageMode(PdfPageMode.USE_OUTLINES);
        
        // Set the "DefaultBookmarksOutlineLevel" property to "1" to display all
        // bookmarks at the first level of the outline in the output PDF.
        saveOptions.getOutlineOptions().setDefaultBookmarksOutlineLevel(1);
        
        // Set the "HeaderFooterBookmarksExportMode" property to "HeaderFooterBookmarksExportMode.None" to
        // not export any bookmarks that are inside headers/footers.
        // Set the "HeaderFooterBookmarksExportMode" property to "HeaderFooterBookmarksExportMode.First" to
        // only export bookmarks in the first section's header/footers.
        // Set the "HeaderFooterBookmarksExportMode" property to "HeaderFooterBookmarksExportMode.All" to
        // export bookmarks that are in all headers/footers.
        saveOptions.setHeaderFooterBookmarksExportMode(headerFooterBookmarksExportMode);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.HeaderFooterBookmarksExportMode.pdf", saveOptions);
      • getImageColorSpaceExportMode/setImageColorSpaceExportMode

        public int getImageColorSpaceExportMode() / public void setImageColorSpaceExportMode(int value)
        
        Specifies how the color space will be selected for the images in PDF document. The value of the property is PdfImageColorSpaceExportMode integer constant. The default value is PdfImageColorSpaceExportMode.AUTO. If PdfImageColorSpaceExportMode.SIMPLE_CMYK value is specified, ImageCompression option is ignored and Flate compression is used for all images in the document.

        Example:

        Shows how to set a different color space for images in a document as we export it to PDF.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.writeln("Jpeg image:");
        builder.insertImage(getImageDir() + "Logo.jpg");
        builder.insertParagraph();
        builder.writeln("Png image:");
        builder.insertImage(getImageDir() + "Transparent background logo.png");
        
        // 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 pdfSaveOptions = new PdfSaveOptions();
        
        // Set the "ImageColorSpaceExportMode" property to "PdfImageColorSpaceExportMode.Auto" to get Aspose.Words to
        // automatically select the color space for images in the document that it converts to PDF.
        // In most cases, the color space will be RGB.
        // Set the "ImageColorSpaceExportMode" property to "PdfImageColorSpaceExportMode.SimpleCmyk"
        // to use the CMYK color space for all images in the saved PDF.
        // Aspose.Words will also apply Flate compression to all images and ignore the "ImageCompression" property's value.
        pdfSaveOptions.setImageColorSpaceExportMode(pdfImageColorSpaceExportMode);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.ImageColorSpaceExportMode.pdf", pdfSaveOptions);
      • getImageCompression/setImageCompression

        public int getImageCompression() / public void setImageCompression(int value)
        
        Specifies compression type to be used for all images in the document. The value of the property is PdfImageCompression integer constant.

        Default is PdfImageCompression.AUTO.

        Using PdfImageCompression.JPEG lets you control the quality of images in the output document through the JpegQuality property.

        Using PdfImageCompression.JPEG provides the fastest conversion speed when compared to the performance of other compression types, but in this case, there is lossy JPEG compression.

        Using PdfImageCompression.AUTO lets to control the quality of Jpeg in the output document through the JpegQuality property, but for other formats, raw pixel data is extracted and saved with Flate compression. This case is slower than Jpeg conversion but lossless.

        Example:

        Shows how to specify a compression type for all images in a document that we are converting to PDF.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.writeln("Jpeg image:");
        builder.insertImage(getImageDir() + "Logo.jpg");
        builder.insertParagraph();
        builder.writeln("Png image:");
        builder.insertImage(getImageDir() + "Transparent background logo.png");
        
        // 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 pdfSaveOptions = new PdfSaveOptions();
        
        // Set the "ImageCompression" property to "PdfImageCompression.Auto" to use the
        // "ImageCompression" property to control the quality of the Jpeg images that end up in the output PDF.
        // Set the "ImageCompression" property to "PdfImageCompression.Jpeg" to use the
        // "ImageCompression" property to control the quality of all images that end up in the output PDF.
        pdfSaveOptions.setImageCompression(pdfImageCompression);
        
        // Set the "JpegQuality" property to "10" to strengthen compression at the cost of image quality.
        pdfSaveOptions.setJpegQuality(10);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.ImageCompression.pdf", pdfSaveOptions);
      • getInterpolateImages/setInterpolateImages

        public boolean getInterpolateImages() / public void setInterpolateImages(boolean value)
        
        A flag indicating whether image interpolation shall be performed by a conforming reader. When false is specified, the flag is not written to the output document and the default behaviour of reader is used instead.

        When the resolution of a source image is significantly lower than that of the output device, each source sample covers many device pixels. As a result, images can appear jaggy or blocky. These visual artifacts can be reduced by applying an image interpolation algorithm during rendering. Instead of painting all pixels covered by a source sample with the same color, image interpolation attempts to produce a smooth transition between adjacent sample values.

        A conforming Reader may choose to not implement this feature of PDF, or may use any specific implementation of interpolation that it wishes.

        The default value is false.

        Example:

        Shows how to perform interpolation on images while saving a document to PDF.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        BufferedImage img = ImageIO.read(new File(getImageDir() + "Transparent background logo.png"));
        builder.insertImage(img);
        
        // 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 saveOptions = new PdfSaveOptions();
        
        // Set the "InterpolateImages" property to "true" to get the reader that opens this document to interpolate images.
        // Their resolution should be lower than that of the device that is displaying the document.
        // Set the "InterpolateImages" property to "false" to make it so that the reader does not apply any interpolation.
        saveOptions.setInterpolateImages(interpolateImages);
        
        // When we open this document with a reader such as Adobe Acrobat, we will need to zoom in on the image
        // to see the interpolation effect if we saved the document with it enabled.
        doc.save(getArtifactsDir() + "PdfSaveOptions.InterpolateImages.pdf", saveOptions);
      • getJpegQuality/setJpegQuality

        public int getJpegQuality() / public void setJpegQuality(int value)
        
        Gets or sets a value determining the quality of the JPEG images inside PDF document.

        The default value is 100.

        This property is used in conjunction with the ImageCompression option.

        Has effect only when a document contains JPEG images.

        Use this property to get or set the quality of the images inside a document when saving in PDF format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression. If quality is 100 and source image is JPEG, it means no compression - original bytes will be saved.

        Example:

        Shows how to specify a compression type for all images in a document that we are converting to PDF.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.writeln("Jpeg image:");
        builder.insertImage(getImageDir() + "Logo.jpg");
        builder.insertParagraph();
        builder.writeln("Png image:");
        builder.insertImage(getImageDir() + "Transparent background logo.png");
        
        // 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 pdfSaveOptions = new PdfSaveOptions();
        
        // Set the "ImageCompression" property to "PdfImageCompression.Auto" to use the
        // "ImageCompression" property to control the quality of the Jpeg images that end up in the output PDF.
        // Set the "ImageCompression" property to "PdfImageCompression.Jpeg" to use the
        // "ImageCompression" property to control the quality of all images that end up in the output PDF.
        pdfSaveOptions.setImageCompression(pdfImageCompression);
        
        // Set the "JpegQuality" property to "10" to strengthen compression at the cost of image quality.
        pdfSaveOptions.setJpegQuality(10);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.ImageCompression.pdf", pdfSaveOptions);
      • getMemoryOptimization/setMemoryOptimization

        public boolean getMemoryOptimization() / public void setMemoryOptimization(boolean value)
        
        Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false. Setting this option to true can significantly decrease memory consumption while saving large documents at the cost of slower saving time.

        Example:

        Shows an option to optimize memory consumption when rendering large documents to PDF.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        
        // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
        // to modify how that method converts the document to .PDF.
        SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF);
        
        // Set the "MemoryOptimization" property to "true" to lower the memory footprint of large documents' saving operations
        // at the cost of increasing the duration of the operation.
        // Set the "MemoryOptimization" property to "false" to save the document as a PDF normally.
        saveOptions.setMemoryOptimization(memoryOptimization);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.MemoryOptimization.pdf", saveOptions);
      • getMetafileRenderingOptions/setMetafileRenderingOptions

        public MetafileRenderingOptions getMetafileRenderingOptions() / public void setMetafileRenderingOptions(MetafileRenderingOptions value)
        
        Allows to specify metafile rendering options.

        Example:

        Shows added a fallback to bitmap rendering and changing type of warnings about unsupported metafile records.
        public void handleBinaryRasterWarnings() throws Exception
        {
            Document doc = new Document(getMyDir() + "WMF with image.docx");
        
            MetafileRenderingOptions metafileRenderingOptions = new MetafileRenderingOptions();
        
            // Set the "EmulateRasterOperations" property to "false" to fall back to bitmap when
            // it encounters a metafile, which will require raster operations to render in the output PDF.
            metafileRenderingOptions.setEmulateRasterOperations(false);
        
            // Set the "RenderingMode" property to "VectorWithFallback" to try to render every metafile using vector graphics.
            metafileRenderingOptions.setRenderingMode(MetafileRenderingMode.VECTOR_WITH_FALLBACK);
        
            // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
            // to modify how that method converts the document to .PDF and applies the configuration
            // in our MetafileRenderingOptions object to the saving operation.
            PdfSaveOptions saveOptions = new PdfSaveOptions();
            saveOptions.setMetafileRenderingOptions(metafileRenderingOptions);
        
            HandleDocumentWarnings callback = new HandleDocumentWarnings();
            doc.setWarningCallback(callback);
        
            doc.save(getArtifactsDir() + "PdfSaveOptions.HandleBinaryRasterWarnings.pdf", saveOptions);
        
            Assert.assertEquals(1, callback.mWarnings.getCount());
            Assert.assertEquals("'R2_XORPEN' binary raster operation is partly supported.",
                callback.mWarnings.get(0).getDescription());
        }
        
        /// <summary>
        /// Prints and collects formatting loss-related warnings that occur upon saving a document.
        /// </summary>
        public static class HandleDocumentWarnings implements IWarningCallback
        {
            public void warning(WarningInfo info)
            {
                if (info.getWarningType() == WarningType.MINOR_FORMATTING_LOSS)
                {
                    System.out.println("Unsupported operation: " + info.getDescription());
                    this.mWarnings.warning(info);
                }
            }
        
            public WarningInfoCollection mWarnings = new WarningInfoCollection();
        }
      • getNumeralFormat/setNumeralFormat

        public int getNumeralFormat() / public void setNumeralFormat(int value)
        
        Gets or sets NumeralFormat used for rendering of numerals. European numerals are used by default. The value of the property is NumeralFormat integer constant. If the value of this property is changed and page layout is already built then Document.updatePageLayout() is invoked automatically to update any changes.

        Example:

        Shows how to set the numeral format used when saving to PDF.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getFont().setLocaleId(1025);
        builder.writeln("1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 50, 100");
        
        // 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 "NumeralFormat" property to "NumeralFormat.ArabicIndic" to
        // use glyphs from the U+0660 to U+0669 range as numbers.
        // Set the "NumeralFormat" property to "NumeralFormat.Context" to
        // look up the locale to determine what number of glyphs to use.
        // Set the "NumeralFormat" property to "NumeralFormat.EasternArabicIndic" to
        // use glyphs from the U+06F0 to U+06F9 range as numbers.
        // Set the "NumeralFormat" property to "NumeralFormat.European" to use european numerals.
        // Set the "NumeralFormat" property to "NumeralFormat.System" to determine the symbol set from regional settings.
        options.setNumeralFormat(numeralFormat);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.SetNumeralFormat.pdf", options);
      • getOpenHyperlinksInNewWindow/setOpenHyperlinksInNewWindow

        public boolean getOpenHyperlinksInNewWindow() / public void setOpenHyperlinksInNewWindow(boolean value)
        
        Gets or sets a value determining whether hyperlinks in the output Pdf document are forced to be opened in a new window (or tab) of a browser.

        The default value is false. When this value is set to true hyperlinks are saved using JavaScript code. JavaScript code is app.launchURL("URL", true);, where URL is a hyperlink.

        Note that if this option is set to true hyperlinks can't work in some PDF readers e.g. Chrome, Firefox.

        Example:

        Shows how to save hyperlinks in a document we convert to PDF so that they open new pages when we click on them.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.insertHyperlink("Testlink", "https://www.google.com/search?q=%20aspose", false);
        
        // 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 "OpenHyperlinksInNewWindow" property to "true" to save all hyperlinks using Javascript code
        // that forces readers to open these links in new windows/browser tabs.
        // Set the "OpenHyperlinksInNewWindow" property to "false" to save all hyperlinks normally.
        options.setOpenHyperlinksInNewWindow(openHyperlinksInNewWindow);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.OpenHyperlinksInNewWindow.pdf", options);
      • getOptimizeOutput/setOptimizeOutput

        public boolean getOptimizeOutput() / public void setOptimizeOutput(boolean value)
        
        Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false.

        Example:

        Shows how to simplify a document when saving it to HTML by removing various redundant objects.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        
        HtmlFixedSaveOptions saveOptions = new HtmlFixedSaveOptions();
        {
            saveOptions.setOptimizeOutput(optimizeOutput);
        }
        
        doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.OptimizeGraphicsOutput.html", saveOptions);

        Example:

        Shows how to optimize document objects while saving to xps.
        Document doc = new Document(getMyDir() + "Unoptimized document.docx");
        
        // When saving to .xps, we can use SaveOptions to optimize the output in some cases
        XpsSaveOptions saveOptions = new XpsSaveOptions(); { saveOptions.setOptimizeOutput(optimizeOutput); }
        
        doc.save(getArtifactsDir() + "XpsSaveOptions.OptimizeOutput.xps", saveOptions);
      • getOutlineOptions

        public OutlineOptions getOutlineOptions()
        
        Allows to specify outline options.

        Outlines can be created from headings and bookmarks.

        For headings outline level is determined by the heading level.

        It is possible to set the max heading level to be included into outlines or disable heading outlines at all.

        For bookmarks outline level may be set in options as a default value for all bookmarks or as individual values for particular bookmarks.

        Also, outlines can be exported to XPS format by using the same OutlineOptions class.

        Example:

        Shows how to limit the headings' level that will appear in the outline of a saved PDF document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert headings that can serve as TOC entries of levels 1, 2, and then 3.
        builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
        
        Assert.assertTrue(builder.getParagraphFormat().isHeading());
        
        builder.writeln("Heading 1");
        
        builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);
        
        builder.writeln("Heading 1.1");
        builder.writeln("Heading 1.2");
        
        builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_3);
        
        builder.writeln("Heading 1.2.1");
        builder.writeln("Heading 1.2.2");
        
        // 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 saveOptions = new PdfSaveOptions();
        saveOptions.setSaveFormat(SaveFormat.PDF);
        
        // The output PDF document will contain an outline, which is a table of contents that lists headings in the document body.
        // Clicking on an entry in this outline will take us to the location of its respective heading.
        // Set the "HeadingsOutlineLevels" property to "2" to exclude all headings whose levels are above 2 from the outline.
        // The last two headings we have inserted above will not appear.
        saveOptions.getOutlineOptions().setHeadingsOutlineLevels(2);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.HeadingsOutlineLevels.pdf", saveOptions);

        Example:

        Shows how to work with outline levels that do not contain any corresponding headings when saving a PDF document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert headings that can serve as TOC entries of levels 1 and 5.
        builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
        
        Assert.assertTrue(builder.getParagraphFormat().isHeading());
        
        builder.writeln("Heading 1");
        
        builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_5);
        
        builder.writeln("Heading 1.1.1.1.1");
        builder.writeln("Heading 1.1.1.1.2");
        
        // 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 saveOptions = new PdfSaveOptions();
        
        // The output PDF document will contain an outline, which is a table of contents that lists headings in the document body.
        // Clicking on an entry in this outline will take us to the location of its respective heading.
        // Set the "HeadingsOutlineLevels" property to "5" to include all headings of levels 5 and below in the outline.
        saveOptions.getOutlineOptions().setHeadingsOutlineLevels(5);
        
        // This document contains headings of levels 1 and 5, and no headings with levels of 2, 3, and 4. 
        // The output PDF document will treat outline levels 2, 3, and 4 as "missing".
        // Set the "CreateMissingOutlineLevels" property to "true" to include all missing levels in the outline,
        // leaving blank outline entries since there are no usable headings.
        // Set the "CreateMissingOutlineLevels" property to "false" to ignore missing outline levels,
        // and treat the outline level 5 headings as level 2.
        saveOptions.getOutlineOptions().setCreateMissingOutlineLevels(createMissingOutlineLevels);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.CreateMissingOutlineLevels.pdf", saveOptions);
      • getPageMode/setPageMode

        public int getPageMode() / public void setPageMode(int value)
        
        Specifies how the PDF document should be displayed when opened in the PDF reader. The value of the property is PdfPageMode integer constant. The default value is PdfPageMode.USE_OUTLINES.

        Example:

        Shows how to set instructions for some PDF readers to follow when opening an output document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.writeln("Hello world!");
        
        // 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 "PageMode" property to "PdfPageMode.FullScreen" to get the PDF reader to open the saved
        // document in full-screen mode, which takes over the monitor's display and has no controls visible.
        // Set the "PageMode" property to "PdfPageMode.UseThumbs" to get the PDF reader to display a separate panel
        // with a thumbnail for each page in the document.
        // Set the "PageMode" property to "PdfPageMode.UseOC" to get the PDF reader to display a separate panel
        // that allows us to work with any layers present in the document.
        // Set the "PageMode" property to "PdfPageMode.UseOutlines" to get the PDF reader
        // also to display the outline, if possible.
        // Set the "PageMode" property to "PdfPageMode.UseNone" to get the PDF reader to display just the document itself.
        options.setPageMode(pageMode);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.PageMode.pdf", options);

        Example:

        Shows to process bookmarks in headers/footers in a document that we are rendering to PDF.
        Document doc = new Document(getMyDir() + "Bookmarks in headers and footers.docx");
        
        // 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 saveOptions = new PdfSaveOptions();
        
        // Set the "PageMode" property to "PdfPageMode.UseOutlines" to display the outline navigation pane in the output PDF.
        saveOptions.setPageMode(PdfPageMode.USE_OUTLINES);
        
        // Set the "DefaultBookmarksOutlineLevel" property to "1" to display all
        // bookmarks at the first level of the outline in the output PDF.
        saveOptions.getOutlineOptions().setDefaultBookmarksOutlineLevel(1);
        
        // Set the "HeaderFooterBookmarksExportMode" property to "HeaderFooterBookmarksExportMode.None" to
        // not export any bookmarks that are inside headers/footers.
        // Set the "HeaderFooterBookmarksExportMode" property to "HeaderFooterBookmarksExportMode.First" to
        // only export bookmarks in the first section's header/footers.
        // Set the "HeaderFooterBookmarksExportMode" property to "HeaderFooterBookmarksExportMode.All" to
        // export bookmarks that are in all headers/footers.
        saveOptions.setHeaderFooterBookmarksExportMode(headerFooterBookmarksExportMode);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.HeaderFooterBookmarksExportMode.pdf", saveOptions);
      • getPageSavingCallback/setPageSavingCallback

        public IPageSavingCallback getPageSavingCallback() / public void setPageSavingCallback(IPageSavingCallback value)
        
        Allows to control how separate pages are saved when a document is exported to fixed page format.

        Example:

        Shows how to use a callback to save a document to HTML page by page.
        public void pageFileNames() throws Exception
        {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            builder.writeln("Page 1.");
            builder.insertBreak(BreakType.PAGE_BREAK);
            builder.writeln("Page 2.");
            builder.insertImage(getImageDir() + "Logo.jpg");
            builder.insertBreak(BreakType.PAGE_BREAK);
            builder.writeln("Page 3.");
        
            // Create an "HtmlFixedSaveOptions" object, which we can pass to the document's "Save" method
            // to modify how we convert the document to HTML.
            HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions();
        
            // We will save each page in this document to a separate HTML file in the local file system.
            // Set a callback that allows us to name each output HTML document.
            htmlFixedSaveOptions.setPageSavingCallback(new CustomFileNamePageSavingCallback());
        
            doc.save(getArtifactsDir() + "SavingCallback.PageFileNames.html", htmlFixedSaveOptions);
        }
        
        /// <summary>
        /// Saves all pages to a file and directory specified within.
        /// </summary>
        private static class CustomFileNamePageSavingCallback implements IPageSavingCallback
        {
            public void pageSaving(PageSavingArgs args) throws Exception
            {
                String outFileName = MessageFormat.format("{0}SavingCallback.PageFileNames.Page_{1}.html", getArtifactsDir(), args.getPageIndex());
        
                // Below are two ways of specifying where Aspose.Words will save each page of the document.
                // 1 -  Set a filename for the output page file:
                args.setPageFileName(outFileName);
        
                // 2 -  Create a custom stream for the output page file:
                args.setPageStream(new FileOutputStream(outFileName));
        
                Assert.assertFalse(args.getKeepPageStreamOpen());
            }
        }
      • getPageSet/setPageSet

        public PageSet getPageSet() / public void setPageSet(PageSet value)
        
        Gets or sets the pages to render. Default is all the pages in the document.

        Example:

        Shows how to export Odd pages from the document.
        Document doc = new Document(getMyDir() + "Images.docx");
        
        PdfSaveOptions pdfOptions = new PdfSaveOptions(); { pdfOptions.setPageSet(PageSet.getOdd()); }
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.ExportOddPages.pdf", pdfOptions);

        Example:

        Shows how to extract pages based on exact page indices.
        Document doc = new Document(getMyDir() + "Images.docx");
        
        XpsSaveOptions xpsOptions = new XpsSaveOptions();
        xpsOptions.setPageSet(new PageSet(0, 1, 2, 4, 1, 3, 2, 3));
        
        doc.save(getArtifactsDir() + "XpsSaveOptions.ExportExactPages.xps", xpsOptions);

        Example:

        Shows how to convert only some of the pages in a document to PDF.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.writeln("Page 1.");
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.writeln("Page 2.");
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.writeln("Page 3.");
        
        // 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 "PageIndex" to "1" to render a portion of the document starting from the second page.
        options.setPageSet(new PageSet(1));
        
        // This document will contain one page starting from page two, which will only contain the second page.
        doc.save(new FileOutputStream(getArtifactsDir() + "PdfSaveOptions.OnePage.pdf"), options);
      • getPreblendImages/setPreblendImages

        public boolean getPreblendImages() / public void setPreblendImages(boolean value)
        
        Gets or sets a value determining whether or not to preblend transparent images with black background color.

        Preblending images may improve PDF document visual appearance in Adobe Reader and remove anti-aliasing artifacts.

        In order to properly display preblended images, PDF viewer application must support /Matte entry in soft-mask image dictionary. Also preblending images may decrease PDF rendering performance.

        The default value is false.

        Example:

        Shows how to preblend images with transparent backgrounds while saving a document to PDF.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.insertImage(getImageDir() + "Transparent background logo.png");
        
        // 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 "PreblendImages" property to "true" to preblend transparent images
        // with a background, which may reduce artifacts.
        // Set the "PreblendImages" property to "false" to render transparent images normally.
        options.setPreblendImages(preblendImages);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.PreblendImages.pdf", options);
      • getPreserveFormFields/setPreserveFormFields

        public boolean getPreserveFormFields() / public void setPreserveFormFields(boolean value)
        
        Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text. Default is false.

        Microsoft Word form fields include text input, drop down and check box controls.

        When set to false, these fields will be exported as text to PDF. When set to true, these fields will be exported as PDF form fields.

        When exporting form fields to PDF as form fields, some formatting loss might occur because PDF form fields do not support all features of Microsoft Word form fields.

        Also, the output size depends on the content size because editable forms in Microsoft Word are inline objects.

        Example:

        Shows how to save a document to the PDF format using the Save method and the PdfSaveOptions class.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.write("Please select a fruit: ");
        
        // Insert a combo box which will allow a user to choose an option from a collection of strings.
        builder.insertComboBox("MyComboBox", new String[] { "Apple", "Banana", "Cherry" }, 0);
        
        // 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 pdfOptions = new PdfSaveOptions();
        
        // Set the "PreserveFormFields" property to "true" to save form fields as interactive objects in the output PDF.
        // Set the "PreserveFormFields" property to "false" to freeze all form fields in the document at
        // their current values and display them as plain text in the output PDF.
        pdfOptions.setPreserveFormFields(preserveFormFields);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.PreserveFormFields.pdf", pdfOptions);
      • getPrettyFormat/setPrettyFormat

        public boolean getPrettyFormat() / public void setPrettyFormat(boolean value)
        
        When true, pretty formats output where applicable. Default value is false.

        Set to true to make HTML, MHTML, EPUB, WordML, RTF, DOCX and ODT output human readable. Useful for testing or debugging.

        Example:

        Shows how to enhance the readability of the raw code of a saved .html document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.writeln("Hello world!");
        
        HtmlSaveOptions htmlOptions = new HtmlSaveOptions(SaveFormat.HTML);
        {
            htmlOptions.setPrettyFormat(usePrettyFormat);
        }
        
        doc.save(getArtifactsDir() + "HtmlSaveOptions.PrettyFormat.html", htmlOptions);
        
        // Enabling pretty format makes the raw html code more readable by adding tab stop and new line characters.
        String html = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.PrettyFormat.html"), StandardCharsets.UTF_8);
        
        if (usePrettyFormat)
            Assert.assertEquals(
                    "<html>\r\n" +
                            "\t<head>\r\n" +
                            "\t\t<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\r\n" +
                            "\t\t<meta http-equiv=\"Content-Style-Type\" content=\"text/css\" />\r\n" +
                            MessageFormat.format("\t\t<meta name=\"generator\" content=\"{0} {1}\" />\r\n", BuildVersionInfo.getProduct(), BuildVersionInfo.getVersion()) +
                            "\t\t<title>\r\n" +
                            "\t\t</title>\r\n" +
                            "\t</head>\r\n" +
                            "\t<body style=\"font-family:'Times New Roman'; font-size:12pt\">\r\n" +
                            "\t\t<div>\r\n" +
                            "\t\t\t<p style=\"margin-top:0pt; margin-bottom:0pt\">\r\n" +
                            "\t\t\t\t<span>Hello world!</span>\r\n" +
                            "\t\t\t</p>\r\n" +
                            "\t\t\t<p style=\"margin-top:0pt; margin-bottom:0pt\">\r\n" +
                            "\t\t\t\t<span style=\"-aw-import:ignore\">&#xa0;</span>\r\n" +
                            "\t\t\t</p>\r\n" +
                            "\t\t</div>\r\n" +
                            "\t</body>\r\n</html>",
                    html);
        else
            Assert.assertEquals(
                    "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />" +
                            "<meta http-equiv=\"Content-Style-Type\" content=\"text/css\" />" +
                            MessageFormat.format("<meta name=\"generator\" content=\"{0} {1}\" /><title></title></head>", BuildVersionInfo.getProduct(), BuildVersionInfo.getVersion()) +
                            "<body style=\"font-family:'Times New Roman'; font-size:12pt\">" +
                            "<div><p style=\"margin-top:0pt; margin-bottom:0pt\"><span>Hello world!</span></p>" +
                            "<p style=\"margin-top:0pt; margin-bottom:0pt\"><span style=\"-aw-import:ignore\">&#xa0;</span></p></div></body></html>",
                    html);
      • getSaveFormat/setSaveFormat

        public int getSaveFormat() / public void setSaveFormat(int value)
        
        Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.PDF. The value of the property is SaveFormat integer constant.

        Example:

        Shows how to limit the headings' level that will appear in the outline of a saved PDF document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert headings that can serve as TOC entries of levels 1, 2, and then 3.
        builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
        
        Assert.assertTrue(builder.getParagraphFormat().isHeading());
        
        builder.writeln("Heading 1");
        
        builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);
        
        builder.writeln("Heading 1.1");
        builder.writeln("Heading 1.2");
        
        builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_3);
        
        builder.writeln("Heading 1.2.1");
        builder.writeln("Heading 1.2.2");
        
        // 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 saveOptions = new PdfSaveOptions();
        saveOptions.setSaveFormat(SaveFormat.PDF);
        
        // The output PDF document will contain an outline, which is a table of contents that lists headings in the document body.
        // Clicking on an entry in this outline will take us to the location of its respective heading.
        // Set the "HeadingsOutlineLevels" property to "2" to exclude all headings whose levels are above 2 from the outline.
        // The last two headings we have inserted above will not appear.
        saveOptions.getOutlineOptions().setHeadingsOutlineLevels(2);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.HeadingsOutlineLevels.pdf", saveOptions);
      • getTempFolder/setTempFolder

        public java.lang.String getTempFolder() / public void setTempFolder(java.lang.String value)
        
        Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is null and no temporary files are used.

        When Aspose.Words saves a document, it needs to create temporary internal structures. By default, these internal structures are created in memory and the memory usage spikes for a short period while the document is being saved. When saving is complete, the memory is freed and reclaimed by the garbage collector.

        If you are saving a very large document (thousands of pages) and/or processing many documents at the same time, then the memory spike during saving can be significant enough to cause the system to throw System.OutOfMemoryException. Specifying a temporary folder using TempFolder will cause Aspose.Words to keep the internal structures in temporary files instead of memory. It reduces the memory usage during saving, but will decrease the save performance.

        The folder must exist and be writable, otherwise an exception will be thrown.

        Aspose.Words automatically deletes all temporary files when saving is complete.

        Example:

        Shows how to use the hard drive instead of memory when saving a document.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        
        // When we save a document, various elements are temporarily stored in memory as the save operation is taking place.
        // We can use this option to use a temporary folder in the local file system instead,
        // which will reduce our application's memory overhead.
        DocSaveOptions options = new DocSaveOptions();
        options.setTempFolder(getArtifactsDir() + "TempFiles");
        
        // The specified temporary folder must exist in the local file system before the save operation.
        new File(options.getTempFolder()).mkdir();
        
        doc.save(getArtifactsDir() + "DocSaveOptions.TempFolder.doc", options);
        
        // The folder will persist with no residual contents from the load operation.
        Assert.assertEquals(new File(options.getTempFolder()).listFiles().length, 0);
      • getTextCompression/setTextCompression

        public int getTextCompression() / public void setTextCompression(int value)
        
        Specifies compression type to be used for all textual content in the document. The value of the property is PdfTextCompression integer constant.

        Default is PdfTextCompression.FLATE.

        Significantly increases output size when saving a document without compression.

        Example:

        Shows how to apply text compression when saving a document to PDF.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        for (int i = 0; i < 100; i++)
            builder.writeln("Lorem ipsum dolor sit amet, consectetur adipiscing elit, " +
                            "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
        
        // 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 "TextCompression" property to "PdfTextCompression.None" to not apply any
        // compression to text when we save the document to PDF.
        // Set the "TextCompression" property to "PdfTextCompression.Flate" to apply ZIP compression
        // to text when we save the document to PDF. The larger the document, the bigger the impact that this will have.
        options.setTextCompression(pdfTextCompression);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.TextCompression.pdf", options);
      • getUpdateFields/setUpdateFields

        public boolean getUpdateFields() / public void setUpdateFields(boolean value)
        
        Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true. Allows to specify whether to mimic or not MS Word behavior.

        Example:

        Shows how to update all the fields in a document immediately before saving it to PDF.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert text with PAGE and NUMPAGES fields. These fields do not display the correct value in real time.
        // We will need to manually update them using updating methods such as "Field.Update()", and "Document.UpdateFields()"
        // each time we need them to display accurate values.
        builder.write("Page ");
        builder.insertField("PAGE", "");
        builder.write(" of ");
        builder.insertField("NUMPAGES", "");
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.writeln("Hello World!");
        
        // 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 "UpdateFields" property to "false" to not update all the fields in a document right before a save operation.
        // This is the preferable option if we know that all our fields will be up to date before saving.
        // Set the "UpdateFields" property to "true" to iterate through all the document
        // fields and update them before we save it as a PDF. This will make sure that all the fields will display
        // the most accurate values in the PDF.
        options.setUpdateFields(updateFields);
        
        // We can clone PdfSaveOptions objects.
        Assert.assertNotSame(options, options.deepClone());
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.UpdateFields.pdf", options);
      • getUpdateLastPrintedProperty/setUpdateLastPrintedProperty

        public boolean getUpdateLastPrintedProperty() / public void setUpdateLastPrintedProperty(boolean value)
        
        Gets or sets a value determining whether the BuiltInDocumentProperties.LastPrinted property is updated before saving.

        Example:

        Shows how to update a document's "Last printed" property when saving.
        Document doc = new Document();
        
        // This flag determines whether the last printed date, which is a built-in property, is updated.
        // If so, then the date of the document's most recent save operation
        // with this SaveOptions object passed as a parameter is used as the print date.
        DocSaveOptions saveOptions = new DocSaveOptions();
        saveOptions.setUpdateLastPrintedProperty(isUpdateLastPrintedProperty);
        
        // In Microsoft Word 2003, this property can be found via File -> Properties -> Statistics -> Printed.
        // It can also be displayed in the document's body by using a PRINTDATE field.
        doc.save(getArtifactsDir() + "DocSaveOptions.UpdateLastPrintedProperty.doc", saveOptions);
        
        // Open the saved document, then verify the value of the property.
        doc = new Document(getArtifactsDir() + "DocSaveOptions.UpdateLastPrintedProperty.doc");
        
        Assert.assertNotEquals(Calendar.getInstance().getTime(), doc.getBuiltInDocumentProperties().getLastPrinted());
      • getUpdateLastSavedTimeProperty/setUpdateLastSavedTimeProperty

        public boolean getUpdateLastSavedTimeProperty() / public void setUpdateLastSavedTimeProperty(boolean value)
        
        Gets or sets a value determining whether the BuiltInDocumentProperties.LastSavedTime property is updated before saving.

        Example:

        Shows how to determine whether to preserve the document's "Last saved time" property when saving.
        Document doc = new Document(getMyDir() + "Document.docx");
        
        // When we save the document to an OOXML format, we can create an OoxmlSaveOptions object
        // and then pass it to the document's saving method to modify how we save the document.
        // Set the "UpdateLastSavedTimeProperty" property to "true" to
        // set the output document's "Last saved time" built-in property to the current date/time.
        // Set the "UpdateLastSavedTimeProperty" property to "false" to
        // preserve the original value of the input document's "Last saved time" built-in property.
        OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
        saveOptions.setUpdateLastSavedTimeProperty(updateLastSavedTimeProperty);
        
        doc.save(getArtifactsDir() + "OoxmlSaveOptions.LastSavedTime.docx", saveOptions);
      • getUpdateSdtContent/setUpdateSdtContent

        public boolean getUpdateSdtContent() / public void setUpdateSdtContent(boolean value)
        
        Gets or sets value determining whether content of StructuredDocumentTag is updated before saving. The default value is true.

        Example:

        Shows how structured document tags can be updated while saving to .pdf.
        Document doc = new Document();
        
        // Insert two StructuredDocumentTags; a date and a drop down list
        StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.DATE, MarkupLevel.BLOCK);
        tag.setFullDate(new Date());
        
        doc.getFirstSection().getBody().appendChild(tag);
        
        tag = new StructuredDocumentTag(doc, SdtType.DROP_DOWN_LIST, MarkupLevel.BLOCK);
        tag.getListItems().add(new SdtListItem("Value 1"));
        tag.getListItems().add(new SdtListItem("Value 2"));
        tag.getListItems().add(new SdtListItem("Value 3"));
        tag.getListItems().setSelectedValue(tag.getListItems().get(1));
        
        doc.getFirstSection().getBody().appendChild(tag);
        
        // We've selected default values for both tags
        // We can save those values in the document without immediately updating the tags, leaving them in their default state
        // by using a SaveOptions object with this flag set
        PdfSaveOptions options = new PdfSaveOptions();
        options.setUpdateSdtContent(updateSdtContent);
        
        doc.save(getArtifactsDir() + "StructuredDocumentTag.UpdateSdtContent.pdf", options);
      • getUseAntiAliasing/setUseAntiAliasing

        public boolean getUseAntiAliasing() / public void setUseAntiAliasing(boolean value)
        
        Gets or sets a value determining whether or not to use anti-aliasing for rendering.

        The default value is false. When this value is set to true anti-aliasing is used for rendering.

        This property is used when the document is exported to the following formats: SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF. When the document is exported to the SaveFormat.HTML, SaveFormat.MHTML and SaveFormat.EPUB formats this option is used for raster images.

        Example:

        Shows how to improve the quality of a rendered document with SaveOptions.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getFont().setSize(60.0);
        builder.writeln("Some text.");
        
        SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG);
        
        doc.save(getArtifactsDir() + "Document.ImageSaveOptions.Default.jpg", options);
        
        options.setUseAntiAliasing(true);
        options.setUseHighQualityRendering(true);
        
        doc.save(getArtifactsDir() + "Document.ImageSaveOptions.HighQuality.jpg", options);
      • getUseBookFoldPrintingSettings/setUseBookFoldPrintingSettings

        public boolean getUseBookFoldPrintingSettings() / public void setUseBookFoldPrintingSettings(boolean value)
        
        Gets or sets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via PageSetup.MultiplePages.

        If this option is specified, PageSet is ignored when saving. This behavior matches MS Word. If book fold printing settings are not specified in page setup, this option will have no effect.

        Example:

        Shows how to save a document to the PDF format in the form of a book fold.
        Document doc = new Document(getMyDir() + "Paragraphs.docx");
        
        // 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 "UseBookFoldPrintingSettings" property to "true" to arrange the contents
        // in the output PDF in a way that helps us use it to make a booklet.
        // Set the "UseBookFoldPrintingSettings" property to "false" to render the PDF normally.
        options.setUseBookFoldPrintingSettings(renderTextAsBookfold);
        
        // If we are rendering the document as a booklet, we must set the "MultiplePages"
        // properties of all page setup objects of all sections to "MultiplePagesType.BookFoldPrinting".
        if (renderTextAsBookfold)
            for (Section s : (Iterable<Section>) doc.getSections())
            {
            s.getPageSetup().setMultiplePages(MultiplePagesType.BOOK_FOLD_PRINTING);
        }
        
        // Once we print this document on both sides of the pages, we can fold all the pages down the middle at once,
        // and the contents will line up in a way that creates a booklet.
        doc.save(getArtifactsDir() + "PdfSaveOptions.SaveAsPdfBookFold.pdf", options);
      • getUseCoreFonts/setUseCoreFonts

        public boolean getUseCoreFonts() / public void setUseCoreFonts(boolean value)
        
        Gets or sets a value determining whether or not to substitute TrueType fonts Arial, Times New Roman, Courier New and Symbol with core PDF Type 1 fonts.

        The default value is false. When this value is set to true Arial, Times New Roman, Courier New and Symbol fonts are replaced in PDF document with corresponding core Type 1 font.

        Core PDF fonts, or their font metrics and suitable substitution fonts, are required to be available to any PDF viewer application.

        This setting works only for the text in ANSI (Windows-1252) encoding. Non-ANSI text will be written with embedded TrueType font regardless of this setting.

        Settings core fonts to true is not allowed when saving to PDF/A as this compliance requires all fonts to be embedded.

        This option has a higher priority then FontEmbeddingMode option.

        Example:

        Shows how enable/disable PDF Type 1 font substitution.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getFont().setName("Arial");
        builder.writeln("Hello world!");
        builder.getFont().setName("Courier New");
        builder.writeln("The quick brown fox jumps over the lazy dog.");
        
        // 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 "UseCoreFonts" property to "true" to replace some fonts,
        // including the two fonts in our document, with their PDF Type 1 equivalents.
        // Set the "UseCoreFonts" property to "false" to not apply PDF Type 1 fonts.
        options.setUseCoreFonts(useCoreFonts);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.EmbedCoreFonts.pdf", options);
      • getUseHighQualityRendering/setUseHighQualityRendering

        public boolean getUseHighQualityRendering() / public void setUseHighQualityRendering(boolean value)
        
        Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. The default value is false.

        This property is used when the document is exported to image formats: SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF.

        Example:

        Shows how to improve the quality of a rendered document with SaveOptions.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getFont().setSize(60.0);
        builder.writeln("Some text.");
        
        SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG);
        
        doc.save(getArtifactsDir() + "Document.ImageSaveOptions.Default.jpg", options);
        
        options.setUseAntiAliasing(true);
        options.setUseHighQualityRendering(true);
        
        doc.save(getArtifactsDir() + "Document.ImageSaveOptions.HighQuality.jpg", options);
      • getZoomBehavior/setZoomBehavior

        public int getZoomBehavior() / public void setZoomBehavior(int value)
        
        Gets or sets a value determining what type of zoom should be applied when a document is opened with a PDF viewer. The value of the property is PdfZoomBehavior integer constant. The default value is PdfZoomBehavior.NONE, i.e. no fit is applied.

        Example:

        Shows how to set the default zooming that a reader applies when opening a rendered PDF document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.writeln("Hello world!");
        
        // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
        // to modify how that method converts the document to .PDF.
        // Set the "ZoomBehavior" property to "PdfZoomBehavior.ZoomFactor" to get a PDF reader to
        // apply a percentage-based zoom factor when we open the document with it.
        // Set the "ZoomFactor" property to "25" to give the zoom factor a value of 25%.
        PdfSaveOptions options = new PdfSaveOptions();
        {
            options.setZoomBehavior(PdfZoomBehavior.ZOOM_FACTOR);
            options.setZoomFactor(25);
        }
        
        // When we open this document using a reader such as Adobe Acrobat, we will see the document scaled at 1/4 of its actual size.
        doc.save(getArtifactsDir() + "PdfSaveOptions.ZoomBehaviour.pdf", options);
      • getZoomFactor/setZoomFactor

        public int getZoomFactor() / public void setZoomFactor(int value)
        
        Gets or sets a value determining zoom factor (in percentages) for a document. This value is used only if ZoomBehavior is set to PdfZoomBehavior.ZOOM_FACTOR.

        Example:

        Shows how to set the default zooming that a reader applies when opening a rendered PDF document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.writeln("Hello world!");
        
        // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
        // to modify how that method converts the document to .PDF.
        // Set the "ZoomBehavior" property to "PdfZoomBehavior.ZoomFactor" to get a PDF reader to
        // apply a percentage-based zoom factor when we open the document with it.
        // Set the "ZoomFactor" property to "25" to give the zoom factor a value of 25%.
        PdfSaveOptions options = new PdfSaveOptions();
        {
            options.setZoomBehavior(PdfZoomBehavior.ZOOM_FACTOR);
            options.setZoomFactor(25);
        }
        
        // When we open this document using a reader such as Adobe Acrobat, we will see the document scaled at 1/4 of its actual size.
        doc.save(getArtifactsDir() + "PdfSaveOptions.ZoomBehaviour.pdf", options);
    • Method Detail

      • deepClone

        public PdfSaveOptions deepClone()
        Creates a deep clone of this object.

        Example:

        Shows how to update all the fields in a document immediately before saving it to PDF.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert text with PAGE and NUMPAGES fields. These fields do not display the correct value in real time.
        // We will need to manually update them using updating methods such as "Field.Update()", and "Document.UpdateFields()"
        // each time we need them to display accurate values.
        builder.write("Page ");
        builder.insertField("PAGE", "");
        builder.write(" of ");
        builder.insertField("NUMPAGES", "");
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.writeln("Hello World!");
        
        // 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 "UpdateFields" property to "false" to not update all the fields in a document right before a save operation.
        // This is the preferable option if we know that all our fields will be up to date before saving.
        // Set the "UpdateFields" property to "true" to iterate through all the document
        // fields and update them before we save it as a PDF. This will make sure that all the fields will display
        // the most accurate values in the PDF.
        options.setUpdateFields(updateFields);
        
        // We can clone PdfSaveOptions objects.
        Assert.assertNotSame(options, options.deepClone());
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.UpdateFields.pdf", options);
      • equals

        public boolean equals(java.lang.Object obj)
        Determines whether the specified object is equal in value to the current object.