com.aspose.words

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:

  Demonstrates how to set Aspose.Words to embed full fonts in the output PDF document.

  // Load the document to render
  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // Aspose.Words embeds full fonts by default when EmbedFullFonts is set to true
  // The property below can be changed each time a document is rendered
  PdfSaveOptions options = new PdfSaveOptions();
  options.setEmbedFullFonts(true);
  
  // The output PDF will be embedded with all fonts found in the document
  doc.save(getArtifactsDir() + "Rendering.EmbedFullFonts.pdf", options);

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");
  
  // This may help to overcome issues with inaccurate text positioning with some printers, even if the PDF looks fine,
  // but the file size will increase due to higher text positioning precision used
  PdfSaveOptions saveOptions = new PdfSaveOptions();
  {
      saveOptions.setAdditionalTextPositioning(applyAdditionalTextPositioning);
      saveOptions.setTextCompression(PdfTextCompression.NONE);
  }
  
  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 change image color with save options property.

  Document doc = new Document(getMyDir() + "Images.docx");
  
  // Configure PdfSaveOptions to save every image in the input document in greyscale during conversion
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  {
      pdfSaveOptions.setColorMode(ColorMode.GRAYSCALE);
  }
  
  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 save images to PDF using JPEG encoding to decrease file size.

  Document doc = new Document(getMyDir() + "Images.docx");
  
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  pdfSaveOptions.setImageCompression(PdfImageCompression.JPEG);
  pdfSaveOptions.getDownsampleOptions().setDownsampleImages(false);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.ImageCompression.pdf", pdfSaveOptions);
  
  PdfSaveOptions pdfSaveOptionsA1B = new PdfSaveOptions();
  pdfSaveOptionsA1B.setCompliance(PdfCompliance.PDF_A_1_B);
  pdfSaveOptionsA1B.setImageCompression(PdfImageCompression.JPEG);
  pdfSaveOptionsA1B.getDownsampleOptions().setDownsampleImages(false);
  // Use JPEG compression at 50% quality to reduce file size
  pdfSaveOptionsA1B.setJpegQuality(100);
  pdfSaveOptionsA1B.setImageColorSpaceExportMode(PdfImageColorSpaceExportMode.SIMPLE_CMYK);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.ImageCompression.PDF_A_1_B.pdf", pdfSaveOptionsA1B);
  
  PdfSaveOptions pdfSaveOptionsA1A = new PdfSaveOptions();
  pdfSaveOptionsA1A.setCompliance(PdfCompliance.PDF_A_1_A);
  pdfSaveOptionsA1A.setExportDocumentStructure(true);
  pdfSaveOptionsA1A.setImageCompression(PdfImageCompression.JPEG);
  pdfSaveOptionsA1A.getDownsampleOptions().setDownsampleImages(false);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.ImageCompression.PDF_A_1_A.pdf", pdfSaveOptionsA1A);

• 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 work like hyperlinks.

  // Open a document with footnotes/endnotes
  Document doc = new Document(getMyDir() + "Footnotes and endnotes.docx");
  
  // Creating a PdfSaveOptions instance with this flag set will convert footnote/endnote number symbols in the text
  // into hyperlinks pointing to the footnotes, and the actual footnotes/endnotes at the end of pages into links to their
  // referenced body text
  PdfSaveOptions options = new PdfSaveOptions();
  options.setCreateNoteHyperlinks(doCreateHyperlinks);
  
  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 saving to .pdf.

  Document doc = new Document();
  
  // Add a custom document property that doesn't use the name of some built in properties
  doc.getCustomDocumentProperties().add("Company", "My value");
  
  // Configure the PdfSaveOptions like this will display the properties
  // in the "Document Properties" menu of Adobe Acrobat Pro
  PdfSaveOptions options = new PdfSaveOptions();
  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 using Aspose.Words.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.writeln("Signed PDF contents.");
  
  // Load the certificate from disk
  // The other constructor overloads can be used to load certificates from different locations
  CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw");
  
  // Pass the certificate and details to the save options class to sign with
  PdfSaveOptions options = new PdfSaveOptions();
  Date signingTime = new Date();
  options.setDigitalSignatureDetails(new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "Aspose Office", signingTime));
  
  // We can use this attribute to set a different hash algorithm
  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 title of the document as title bar.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  doc.getBuiltInDocumentProperties().setTitle("Windows bar pdf title");
  
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  pdfSaveOptions.setDisplayDocTitle(true);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.WindowsBarPdfTitle.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 DrawingML rendering quality with PdfSaveOptions.

  Document doc = new Document(getMyDir() + "DrawingML shape effects.docx");
  
  PdfSaveOptions options = new PdfSaveOptions();
  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");
  
  PdfSaveOptions options = new PdfSaveOptions();
  options.setDmlRenderingMode(dmlRenderingMode);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLFallback.pdf", options);

  Example:

  Shows how to configure DrawingML rendering quality with PdfSaveOptions.

  Document doc = new Document(getMyDir() + "DrawingML shape effects.docx");
  
  PdfSaveOptions options = new PdfSaveOptions();
  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 output pdf documents.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // Create a SaveOptions object, verify its default image downsampling settings,
  // and then convert the document to .pdf with it.
  PdfSaveOptions options = new PdfSaveOptions();
  
  Assert.assertTrue(options.getDownsampleOptions().getDownsampleImages());
  Assert.assertEquals(220, options.getDownsampleOptions().getResolution());
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.DownsampleOptions.Default.pdf", options);
  
  // Set the output resolution to a lower value, then set a downsampling resolution threshold
  // which will prevent any images with a resolution of less than 128 from being downsampled.
  options.getDownsampleOptions().setResolution(36);
  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:

  Demonstrates how to set Aspose.Words to embed full fonts in the output PDF document.

  // Load the document to render
  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // Aspose.Words embeds full fonts by default when EmbedFullFonts is set to true
  // The property below can be changed each time a document is rendered
  PdfSaveOptions options = new PdfSaveOptions();
  options.setEmbedFullFonts(true);
  
  // The output PDF will be embedded with all fonts found in the document
  doc.save(getArtifactsDir() + "Rendering.EmbedFullFonts.pdf", options);

  Example:

  Demonstrates how to set Aspose.Words to subset fonts in the output PDF.

  // Load the document to render
  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // To subset fonts in the output PDF document, simply create new PdfSaveOptions and set EmbedFullFonts to false
  PdfSaveOptions options = new PdfSaveOptions();
  options.setEmbedFullFonts(false);
  
  // The output PDF will contain subsets of the fonts in the document
  // Only the glyphs used in the document are included in the PDF fonts
  doc.save(getArtifactsDir() + "Rendering.SubsetFonts.pdf", options);

• 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:

  Demonstrates how to set permissions on a PDF document generated by Aspose.Words.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  PdfSaveOptions saveOptions = new PdfSaveOptions();
  
  // Create encryption details and set owner password
  PdfEncryptionDetails encryptionDetails = new PdfEncryptionDetails("", "password", PdfEncryptionAlgorithm.RC_4_128);
  
  // Start by disallowing all permissions
  encryptionDetails.setPermissions(PdfPermissions.DISALLOW_ALL);
  
  // Extend permissions to allow editing or modifying annotations
  encryptionDetails.setPermissions(PdfPermissions.MODIFY_ANNOTATIONS | PdfPermissions.DOCUMENT_ASSEMBLY);
  saveOptions.setEncryptionDetails(encryptionDetails);
  
  // Render the document to PDF format with the specified permissions
  doc.save(getArtifactsDir() + "Rendering.EncryptionPermissions.pdf", saveOptions);

• getEscapeUri/setEscapeUri

  public boolean getEscapeUri() / public void setEscapeUri(boolean value)
  

  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.

  DocumentBuilder builder = new DocumentBuilder();
  builder.insertHyperlink("Testlink", uri, false);
  
  // Set this property to false if you are sure that hyperlinks in document's model are already escaped
  PdfSaveOptions options = new PdfSaveOptions();
  options.setEscapeUri(isEscaped);
  options.setOpenHyperlinksInNewWindow(true);
  
  builder.getDocument().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 convert a .docx to .pdf while preserving the document structure.

  Document doc = new Document(getMyDir() + "Paragraphs.docx");
  
  // Create a PdfSaveOptions object and configure it to preserve the logical structure that's in the input document
  // The file size will be increased and the structure will be visible in the "Content" navigation pane
  // of Adobe Acrobat Pro
  PdfSaveOptions options = new PdfSaveOptions();
  options.setExportDocumentStructure(doExportStructure);
  
  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.

  // Load the document to render
  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // To disable embedding standard windows font use the PdfSaveOptions and set the EmbedStandardWindowsFonts property to false
  PdfSaveOptions options = new PdfSaveOptions();
  options.setFontEmbeddingMode(PdfFontEmbeddingMode.EMBED_NONE);
  
  // The output PDF will be saved without embedding standard windows fonts
  doc.save(getArtifactsDir() + "Rendering.DisableEmbedWindowsFonts.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 how bookmarks in headers/footers are exported to pdf.

  Document doc = new Document(getMyDir() + "Bookmarks in headers and footers.docx");
  
  // You can specify how bookmarks in headers/footers are exported
  // There is a several options for this:
  // "None" - Bookmarks in headers/footers are not exported
  // "First" - Only bookmark in first header/footer of the section is exported
  // "All" - Bookmarks in all headers/footers are exported
  PdfSaveOptions saveOptions = new PdfSaveOptions();
  
  saveOptions.setHeaderFooterBookmarksExportMode(headerFooterBookmarksExportMode);
  saveOptions.getOutlineOptions().setDefaultBookmarksOutlineLevel(1);
  saveOptions.setPageMode(PdfPageMode.USE_OUTLINES);
  
  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 save images to PDF using JPEG encoding to decrease file size.

  Document doc = new Document(getMyDir() + "Images.docx");
  
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  pdfSaveOptions.setImageCompression(PdfImageCompression.JPEG);
  pdfSaveOptions.getDownsampleOptions().setDownsampleImages(false);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.ImageCompression.pdf", pdfSaveOptions);
  
  PdfSaveOptions pdfSaveOptionsA1B = new PdfSaveOptions();
  pdfSaveOptionsA1B.setCompliance(PdfCompliance.PDF_A_1_B);
  pdfSaveOptionsA1B.setImageCompression(PdfImageCompression.JPEG);
  pdfSaveOptionsA1B.getDownsampleOptions().setDownsampleImages(false);
  // Use JPEG compression at 50% quality to reduce file size
  pdfSaveOptionsA1B.setJpegQuality(100);
  pdfSaveOptionsA1B.setImageColorSpaceExportMode(PdfImageColorSpaceExportMode.SIMPLE_CMYK);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.ImageCompression.PDF_A_1_B.pdf", pdfSaveOptionsA1B);
  
  PdfSaveOptions pdfSaveOptionsA1A = new PdfSaveOptions();
  pdfSaveOptionsA1A.setCompliance(PdfCompliance.PDF_A_1_A);
  pdfSaveOptionsA1A.setExportDocumentStructure(true);
  pdfSaveOptionsA1A.setImageCompression(PdfImageCompression.JPEG);
  pdfSaveOptionsA1A.getDownsampleOptions().setDownsampleImages(false);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.ImageCompression.PDF_A_1_A.pdf", pdfSaveOptionsA1A);

• 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 save images to PDF using JPEG encoding to decrease file size.

  Document doc = new Document(getMyDir() + "Images.docx");
  
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  pdfSaveOptions.setImageCompression(PdfImageCompression.JPEG);
  pdfSaveOptions.getDownsampleOptions().setDownsampleImages(false);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.ImageCompression.pdf", pdfSaveOptions);
  
  PdfSaveOptions pdfSaveOptionsA1B = new PdfSaveOptions();
  pdfSaveOptionsA1B.setCompliance(PdfCompliance.PDF_A_1_B);
  pdfSaveOptionsA1B.setImageCompression(PdfImageCompression.JPEG);
  pdfSaveOptionsA1B.getDownsampleOptions().setDownsampleImages(false);
  // Use JPEG compression at 50% quality to reduce file size
  pdfSaveOptionsA1B.setJpegQuality(100);
  pdfSaveOptionsA1B.setImageColorSpaceExportMode(PdfImageColorSpaceExportMode.SIMPLE_CMYK);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.ImageCompression.PDF_A_1_B.pdf", pdfSaveOptionsA1B);
  
  PdfSaveOptions pdfSaveOptionsA1A = new PdfSaveOptions();
  pdfSaveOptionsA1A.setCompliance(PdfCompliance.PDF_A_1_A);
  pdfSaveOptionsA1A.setExportDocumentStructure(true);
  pdfSaveOptionsA1A.setImageCompression(PdfImageCompression.JPEG);
  pdfSaveOptionsA1A.getDownsampleOptions().setDownsampleImages(false);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.ImageCompression.PDF_A_1_A.pdf", pdfSaveOptionsA1A);

• 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 improve the quality of an image in the rendered documents.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  BufferedImage img = ImageIO.read(new File(getImageDir() + "Transparent background logo.png"));
  builder.insertImage(img);
  
  PdfSaveOptions saveOptions = new PdfSaveOptions();
  saveOptions.setInterpolateImages(true);
  
  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 save images to PDF using JPEG encoding to decrease file size.

  Document doc = new Document(getMyDir() + "Images.docx");
  
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  pdfSaveOptions.setImageCompression(PdfImageCompression.JPEG);
  pdfSaveOptions.getDownsampleOptions().setDownsampleImages(false);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.ImageCompression.pdf", pdfSaveOptions);
  
  PdfSaveOptions pdfSaveOptionsA1B = new PdfSaveOptions();
  pdfSaveOptionsA1B.setCompliance(PdfCompliance.PDF_A_1_B);
  pdfSaveOptionsA1B.setImageCompression(PdfImageCompression.JPEG);
  pdfSaveOptionsA1B.getDownsampleOptions().setDownsampleImages(false);
  // Use JPEG compression at 50% quality to reduce file size
  pdfSaveOptionsA1B.setJpegQuality(100);
  pdfSaveOptionsA1B.setImageColorSpaceExportMode(PdfImageColorSpaceExportMode.SIMPLE_CMYK);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.ImageCompression.PDF_A_1_B.pdf", pdfSaveOptionsA1B);
  
  PdfSaveOptions pdfSaveOptionsA1A = new PdfSaveOptions();
  pdfSaveOptionsA1A.setCompliance(PdfCompliance.PDF_A_1_A);
  pdfSaveOptionsA1A.setExportDocumentStructure(true);
  pdfSaveOptionsA1A.setImageCompression(PdfImageCompression.JPEG);
  pdfSaveOptionsA1A.getDownsampleOptions().setDownsampleImages(false);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.ImageCompression.PDF_A_1_A.pdf", pdfSaveOptionsA1A);

• 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 you work with large documents.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // When set to true it will improve document memory footprint but will add extra time to processing
  SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF);
  saveOptions.setMemoryOptimization(true);
  
  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 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();
      metafileRenderingOptions.setEmulateRasterOperations(false);
      metafileRenderingOptions.setRenderingMode(MetafileRenderingMode.VECTOR_WITH_FALLBACK);
  
      // If Aspose.Words cannot correctly render some of the metafile records to vector graphics then Aspose.Words renders this metafile to a bitmap
      HandleDocumentWarnings callback = new HandleDocumentWarnings();
      doc.setWarningCallback(callback);
  
      PdfSaveOptions saveOptions = new PdfSaveOptions();
      saveOptions.setMetafileRenderingOptions(metafileRenderingOptions);
  
      doc.save(getArtifactsDir() + "PdfSaveOptions.HandleBinaryRasterWarnings.pdf", saveOptions);
  
      Assert.assertEquals(callback.mWarnings.getCount(), 1);
      Assert.assertTrue(callback.mWarnings.get(0).getDescription().contains("R2_XORPEN"));
  }
  
  public static class HandleDocumentWarnings implements IWarningCallback {
      /**
       * Our callback only needs to implement the "Warning" method. This method is called whenever there is a
       * potential issue during document processing. The callback can be set to listen for warnings generated during document
       * load and/or document save.
       */
      public void warning(final WarningInfo info) {
          //For now type of warnings about unsupported metafile records changed from DataLoss/UnexpectedContent to MinorFormattingLoss
          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:

  Demonstrates how to set the numeral format used when saving to PDF.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.writeln("1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 50, 100");
  
  PdfSaveOptions options = new PdfSaveOptions();
  options.setNumeralFormat(NumeralFormat.EASTERN_ARABIC_INDIC);
  
  doc.save(getArtifactsDir() + "Rendering.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 escape hyperlinks in the document.

  DocumentBuilder builder = new DocumentBuilder();
  builder.insertHyperlink("Testlink", uri, false);
  
  // Set this property to false if you are sure that hyperlinks in document's model are already escaped
  PdfSaveOptions options = new PdfSaveOptions();
  options.setEscapeUri(isEscaped);
  options.setOpenHyperlinksInNewWindow(true);
  
  builder.getDocument().save(getArtifactsDir() + "PdfSaveOptions.EscapedUri.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 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);

  Example:

  Shows how to optimize document objects while saving to html.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  HtmlFixedSaveOptions saveOptions = new HtmlFixedSaveOptions();
  {
      saveOptions.setOptimizeOutput(false);
  }
  
  doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.OptimizeGraphicsOutput.Unoptimized.html", saveOptions);
  
  saveOptions.setOptimizeOutput(true);
  
  doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.OptimizeGraphicsOutput.Optimized.html", saveOptions);
  
  Assert.assertTrue(new File(getArtifactsDir() + "HtmlFixedSaveOptions.OptimizeGraphicsOutput.Unoptimized.html").length() >
          new File(getArtifactsDir() + "HtmlFixedSaveOptions.OptimizeGraphicsOutput.Optimized.html").length());

• 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 create PDF document outline entries for headings.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Creating TOC entries
  builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
  Assert.assertTrue(builder.getParagraphFormat().isHeading());
  
  builder.writeln("Heading 1");
  
  builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_4);
  
  builder.writeln("Heading 1.1.1.1");
  builder.writeln("Heading 1.1.1.2");
  
  builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_9);
  
  builder.writeln("Heading 1.1.1.1.1.1.1.1.1");
  builder.writeln("Heading 1.1.1.1.1.1.1.1.2");
  
  // Create "PdfSaveOptions" with some mandatory parameters
  // "HeadingsOutlineLevels" specifies how many levels of headings to include in the document outline
  // "CreateMissingOutlineLevels" determining whether or not to create missing heading levels
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  pdfSaveOptions.getOutlineOptions().setHeadingsOutlineLevels(9);
  pdfSaveOptions.getOutlineOptions().setCreateMissingOutlineLevels(true);
  pdfSaveOptions.setSaveFormat(SaveFormat.PDF);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.CreateMissingOutlineLevels.pdf", pdfSaveOptions);

• getPageCount/setPageCount

  @Deprecated
  public int getPageCount() / public void setPageCount(int value)
  

  Deprecated. Gets or sets the number of pages to save. Default is java.lang.Integer.MAX_VALUE which means all pages of the document will be rendered.

  Overrides PageSet when set.

  Example:

  Converts just one page (third page in this example) of the document to PDF.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  OutputStream stream = new FileOutputStream(getArtifactsDir() + "Rendering.SaveToPdfStreamOnePage.pdf");
  try {
      PdfSaveOptions options = new PdfSaveOptions();
      options.setPageIndex(2);
      options.setPageCount(1);
      doc.save(stream, options);
  } finally {
      if (stream != null) {
          stream.close();
      }
  }

• getPageIndex/setPageIndex

  @Deprecated
  public int getPageIndex() / public void setPageIndex(int value)
  

  Deprecated. Gets or sets the 0-based index of the first page to save. Default is 0.

  Overrides PageSet when set.

  Example:

  Converts just one page (third page in this example) of the document to PDF.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  OutputStream stream = new FileOutputStream(getArtifactsDir() + "Rendering.SaveToPdfStreamOnePage.pdf");
  try {
      PdfSaveOptions options = new PdfSaveOptions();
      options.setPageIndex(2);
      options.setPageCount(1);
      doc.save(stream, options);
  } finally {
      if (stream != null) {
          stream.close();
      }
  }

• 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(getMyDir() + "Document.docx");
  
  PdfSaveOptions options = new PdfSaveOptions();
  options.setPageMode(pageMode);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.PageMode.pdf", options);

  Example:

  Shows how bookmarks in headers/footers are exported to pdf.

  Document doc = new Document(getMyDir() + "Bookmarks in headers and footers.docx");
  
  // You can specify how bookmarks in headers/footers are exported
  // There is a several options for this:
  // "None" - Bookmarks in headers/footers are not exported
  // "First" - Only bookmark in first header/footer of the section is exported
  // "All" - Bookmarks in all headers/footers are exported
  PdfSaveOptions saveOptions = new PdfSaveOptions();
  
  saveOptions.setHeaderFooterBookmarksExportMode(headerFooterBookmarksExportMode);
  saveOptions.getOutlineOptions().setDefaultBookmarksOutlineLevel(1);
  saveOptions.setPageMode(PdfPageMode.USE_OUTLINES);
  
  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 separate pages are saved when a document is exported to fixed page format.

  public void pageFileName() throws Exception {
      Document doc = new Document(getMyDir() + "Rendering.docx");
  
      HtmlFixedSaveOptions htmlFixedSaveOptions =
              new HtmlFixedSaveOptions();
      {
          htmlFixedSaveOptions.setPageIndex(0);
          htmlFixedSaveOptions.setPageCount(doc.getPageCount());
      }
      htmlFixedSaveOptions.setPageSavingCallback(new CustomPageFileNamePageSavingCallback());
  
      doc.save(getArtifactsDir() + "SavingCallback.PageFileName.html", htmlFixedSaveOptions);
  
      ArrayList<String> filePaths = DocumentHelper.directoryGetFiles(getArtifactsDir(), "SavingCallback.PageFileName.Page_*.html");
  
      for (int i = 0; i < doc.getPageCount(); i++) {
          String file = getArtifactsDir() + MessageFormat.format("SavingCallback.PageFileName.Page_{0}.html", i);
      }
  }
  
  /// <summary>
  /// Custom PageFileName is specified.
  /// </summary>
  private static class CustomPageFileNamePageSavingCallback implements IPageSavingCallback {
      public void pageSaving(PageSavingArgs args) throws Exception {
          String outFileName = getArtifactsDir() + MessageFormat.format("SavingCallback.PageFileName.Page_{0}.html", args.getPageIndex());
  
          // Specify name of the output file for the current page either in this 
          args.setPageFileName(outFileName);
  
          // ..or by setting up a custom stream
          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.

  Overrides PageIndex and PageCount when set.

• 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.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.insertImage(getImageDir() + "Transparent background logo.png");
  
  // Setting this flag in a SaveOptions object may change the quality and size of the output .pdf
  // because of the way some images are rendered
  PdfSaveOptions options = new PdfSaveOptions();
  options.setPreblendImages(doPreblendImages);
  
  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.

  // Open the document
  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // Option 1: Save document to file in the PDF format with default options
  doc.save(getArtifactsDir() + "Rendering.PdfDefaultOptions.pdf");
  
  // Option 2: Save the document to stream in the PDF format with default options
  ByteArrayOutputStream stream = new ByteArrayOutputStream();
  doc.save(stream, SaveFormat.PDF);
  
  // Option 3: Save document to the PDF format with specified options
  // Render the first page only and preserve form fields as usable controls and not as plain text
  PdfSaveOptions pdfOptions = new PdfSaveOptions();
  pdfOptions.setPageIndex(0);
  pdfOptions.setPageCount(1);
  pdfOptions.setPreserveFormFields(true);
  doc.save(getArtifactsDir() + "Rendering.PdfCustomOptions.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.

• 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 create PDF document outline entries for headings.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Creating TOC entries
  builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
  Assert.assertTrue(builder.getParagraphFormat().isHeading());
  
  builder.writeln("Heading 1");
  
  builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_4);
  
  builder.writeln("Heading 1.1.1.1");
  builder.writeln("Heading 1.1.1.2");
  
  builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_9);
  
  builder.writeln("Heading 1.1.1.1.1.1.1.1.1");
  builder.writeln("Heading 1.1.1.1.1.1.1.1.2");
  
  // Create "PdfSaveOptions" with some mandatory parameters
  // "HeadingsOutlineLevels" specifies how many levels of headings to include in the document outline
  // "CreateMissingOutlineLevels" determining whether or not to create missing heading levels
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  pdfSaveOptions.getOutlineOptions().setHeadingsOutlineLevels(9);
  pdfSaveOptions.getOutlineOptions().setCreateMissingOutlineLevels(true);
  pdfSaveOptions.setSaveFormat(SaveFormat.PDF);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.CreateMissingOutlineLevels.pdf", pdfSaveOptions);

• 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:

  Saves a document to PDF without compression.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  PdfSaveOptions options = new PdfSaveOptions();
  options.setTextCompression(PdfTextCompression.NONE);
  
  doc.save(getArtifactsDir() + "Rendering.SaveToPdfNoCompression.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 fields before saving into a PDF document.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert two pages of text, including two fields that will need to be updated to display an accurate value
  builder.write("Page ");
  builder.insertField("PAGE", "");
  builder.write(" of ");
  builder.insertField("NUMPAGES", "");
  builder.insertBreak(BreakType.PAGE_BREAK);
  builder.writeln("Hello World!");
  
  PdfSaveOptions options = new PdfSaveOptions();
  options.setUpdateFields(doUpdateFields);
  
  // PdfSaveOptions objects can be cloned
  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 update a document time property when you want to save it.

  Document doc = new Document(getMyDir() + "Document.docx");
  
  // Get last saved time
  Date documentTimeBeforeSave = doc.getBuiltInDocumentProperties().getLastSavedTime();
  
  OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
  saveOptions.setUpdateLastSavedTimeProperty(true);
  
  doc.save(getArtifactsDir() + "OoxmlSaveOptions.UpdatingLastSavedTimeDocument.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, PageIndex and PageCount are 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.

  // Open a document with multiple paragraphs
  Document doc = new Document(getMyDir() + "Paragraphs.docx");
  
  // Configure both page setup and PdfSaveOptions to create a book fold
  for (Section s : (Iterable<Section>) doc.getSections()) {
      s.getPageSetup().setMultiplePages(MultiplePagesType.BOOK_FOLD_PRINTING);
  }
  
  PdfSaveOptions options = new PdfSaveOptions();
  options.setUseBookFoldPrintingSettings(doRenderTextAsBookfold);
  
  // In order to make a booklet, we will need to print this document, stack the pages
  // in the order they come out of the printer and then fold down the middle
  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 to set Aspose.Words to avoid embedding core fonts and let the reader substitute PDF Type 1 fonts instead.

  // Load the document to render
  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // To disable embedding of core fonts and substitute PDF type 1 fonts set UseCoreFonts to true
  PdfSaveOptions options = new PdfSaveOptions();
  options.setUseCoreFonts(true);
  
  // The output PDF will not be embedded with core fonts such as Arial, Times New Roman etc.
  doc.save(getArtifactsDir() + "Rendering.DisableEmbedCoreFonts.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 of an output PDF to 1/4 of default size.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  PdfSaveOptions options = new PdfSaveOptions();
  {
      options.setZoomBehavior(PdfZoomBehavior.ZOOM_FACTOR);
      options.setZoomFactor(25);
  }
  
  // Upon opening the .pdf with a viewer such as Adobe Acrobat Pro, the zoom level will be at 25% by default,
  // with thumbnails for each page to the left
  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 of an output PDF to 1/4 of default size.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  PdfSaveOptions options = new PdfSaveOptions();
  {
      options.setZoomBehavior(PdfZoomBehavior.ZOOM_FACTOR);
      options.setZoomFactor(25);
  }
  
  // Upon opening the .pdf with a viewer such as Adobe Acrobat Pro, the zoom level will be at 25% by default,
  // with thumbnails for each page to the left
  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 fields before saving into a PDF document.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert two pages of text, including two fields that will need to be updated to display an accurate value
  builder.write("Page ");
  builder.insertField("PAGE", "");
  builder.write(" of ");
  builder.insertField("NUMPAGES", "");
  builder.insertBreak(BreakType.PAGE_BREAK);
  builder.writeln("Hello World!");
  
  PdfSaveOptions options = new PdfSaveOptions();
  options.setUpdateFields(doUpdateFields);
  
  // PdfSaveOptions objects can be cloned
  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.