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.

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.

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

  Example:

  Shows how to save the document with PostScript font.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.getFont().setName("PostScriptFont");
  builder.writeln("Some text with PostScript font.");
  
  // Load the font with PostScript to use in the document.
  MemoryFontSource otf = new MemoryFontSource(DocumentHelper.getBytesFromStream(new FileInputStream(getFontsDir() + "AllegroOpen.otf")));
  doc.setFontSettings(new FontSettings());
  doc.getFontSettings().setFontsSources(new FontSourceBase[]{otf});
  
  // Embed TrueType fonts.
  doc.getFontInfos().setEmbedTrueTypeFonts(true);
  
  // Allow embedding PostScript fonts while embedding TrueType fonts.
  // Microsoft Word does not embed PostScript fonts, but can open documents with embedded fonts of this type.
  SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.DOCX);
  saveOptions.setAllowEmbeddingPostScriptFonts(true);
  
  doc.save(getArtifactsDir() + "Document.AllowEmbeddingPostScriptFonts.docx", saveOptions);

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

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

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

• 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. The value of the property is PdfCustomPropertiesExport integer constant.

  Default value is PdfCustomPropertiesExport.NONE.

  PdfCustomPropertiesExport.METADATA value is not supported when saving to PDF/A. PdfCustomPropertiesExport.STANDARD will be used instead for PDF/A-1 and PDF/A-2 and PdfCustomPropertiesExport.NONE for PDF/A-4.

  PdfCustomPropertiesExport.STANDARD value is not supported when saving to PDF 2.0. PdfCustomPropertiesExport.METADATA will be used instead.

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

  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.

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

  This flag is required by PDF/UA compliance. true value will be used automatically when saving to PDF/UA.

  The default value is false.

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

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

• getDownsampleOptions/setDownsampleOptions

  public DownsampleOptions getDownsampleOptions() / public void setDownsampleOptions(DownsampleOptions value)
  

  Allows to specify downsample 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.

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

  AES-128 encryption algorithm is used when saving to PDF 1.7 based compliance (including PDF/UA-1). AES-256 encryption algorithm is used when saving to PDF 2.0 based compliance.

  Encryption is prohibited by PDF/A compliance. This option will be ignored when saving to PDF/A.

  PdfPermissions.CONTENT_COPY_FOR_ACCESSIBILITY permission is required by PDF/UA compliance if the output document is encrypted. This permission will automatically used when saving to PDF/UA.

  PdfPermissions.CONTENT_COPY_FOR_ACCESSIBILITY permission is deprecated in PDF 2.0 format. This permission will be ignored when saving to PDF 2.0.

• 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, PDF/A-2a and PDF/UA-1 because document structure is required for this compliance.

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

• getExportGeneratorName/setExportGeneratorName

  public boolean getExportGeneratorName() / public void setExportGeneratorName(boolean value)
  

  When true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true.

  Example:

  Shows how to disable adding name and version of Aspose.Words into produced files.

  Document doc = new Document();
  
  // Use https://docs.aspose.com/words/net/generator-or-producer-name-included-in-output-documents/ to know how to check the result.
  OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); { saveOptions.setExportGeneratorName(false); }
  
  doc.save(getArtifactsDir() + "OoxmlSaveOptions.ExportGeneratorName.docx", saveOptions);

• getExportLanguageToSpanTag/setExportLanguageToSpanTag

  public boolean getExportLanguageToSpanTag() / public void setExportLanguageToSpanTag(boolean value)
  

  Gets or sets a value determining whether or not to create a "Span" tag in the document structure to export the text language.

  Default value is false and "Lang" attribute is attached to a marked-content sequence in a page content stream.

  When the value is true "Span" tag is created for the text with non-default language and "Lang" attribute is attached to this tag.

  This value is ignored when ExportDocumentStructure is false.

• getFlatOpcXmlMappingOnly/setFlatOpcXmlMappingOnly

  public boolean getFlatOpcXmlMappingOnly() / public void setFlatOpcXmlMappingOnly(boolean value)
  

  Gets or sets value determining which document formats are allowed to be mapped by StructuredDocumentTag.XmlMapping. By default only LoadFormat.FLAT_OPC document format is allowed to be mapped.

  This option is paired with LoadOptions.FlatOpcXmlMappingOnly. Typically you need set both of them to false to allow arbitrary document format mapped.

  Example:

  Shows how to binding structured document tags to any format.

  // If true - SDT will contain raw HTML text.
  // If false - mapped HTML will parsed and resulting document will be inserted into SDT content.
  LoadOptions loadOptions = new LoadOptions(); { loadOptions.setFlatOpcXmlMappingOnly(isFlatOpcXmlMappingOnly); }
  Document doc = new Document(getMyDir() + "Structured document tag with HTML content.docx", loadOptions);
  
  SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF);
  saveOptions.setFlatOpcXmlMappingOnly(isFlatOpcXmlMappingOnly);
  
  doc.save(getArtifactsDir() + "LoadOptions.FlatOpcXmlMappingOnly.pdf", saveOptions);

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

  PDF/A and PDF/UA compliance requires all fonts to be embedded. PdfFontEmbeddingMode.EMBED_ALL value will be used automatically when saving to PDF/A and PDF/UA.

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

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

  PdfImageColorSpaceExportMode.SIMPLE_CMYK value is not supported when saving to PDF/A. PdfImageColorSpaceExportMode.AUTO value will be used instead.

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

• getImlRenderingMode/setImlRenderingMode

  public int getImlRenderingMode() / public void setImlRenderingMode(int value)
  

  Gets or sets a value determining how ink (InkML) objects are rendered. The value of the property is ImlRenderingMode integer constant.

  The default value is ImlRenderingMode.INK_ML.

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

  Example:

  Shows how to render Ink object.

  Document doc = new Document(getMyDir() + "Ink object.docx");
  
  // Set 'ImlRenderingMode.InkML' ignores fall-back shape of ink (InkML) object and renders InkML itself.
  // If the rendering result is unsatisfactory,
  // please use 'ImlRenderingMode.Fallback' to get a result similar to previous versions.
  ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.JPEG);
  {
      saveOptions.setImlRenderingMode(ImlRenderingMode.INK_ML);
  }
  
  doc.save(getArtifactsDir() + "ImageSaveOptions.RenderInkObject.jpeg", saveOptions);

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

  Interpolation flag is prohibited by PDF/A compliance. false value will be used automatically when saving to PDF/A.

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

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

• getMetafileRenderingOptions/setMetafileRenderingOptions

  public MetafileRenderingOptions getMetafileRenderingOptions() / public void setMetafileRenderingOptions(MetafileRenderingOptions value)
  

  Allows to specify metafile rendering options.

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

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

  JavaScript actions are prohibited by PDF/A-1 and PDF/A-2 compliance. false will be used automatically when saving to PDF/A-1 and PDF/A-2.

• 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);
  
  // The size of the optimized version of the document is almost a third of the size of the unoptimized document.
  if (optimizeOutput)
      Assert.assertEquals(62521.0,
          new File(getArtifactsDir() + "HtmlFixedSaveOptions.OptimizeGraphicsOutput.html").length(), 200.0);
  else
      Assert.assertEquals(191770.0,
          new File(getArtifactsDir() + "HtmlFixedSaveOptions.OptimizeGraphicsOutput.html").length(), 200.0);

  Example:

  Shows how to optimize document objects while saving to xps.

  Document doc = new Document(getMyDir() + "Unoptimized document.docx");
  
  // Create an "XpsSaveOptions" object to pass to the document's "Save" method
  // to modify how that method converts the document to .XPS.
  XpsSaveOptions saveOptions = new XpsSaveOptions();
  
  // Set the "OptimizeOutput" property to "true" to take measures such as removing nested or empty canvases
  // and concatenating adjacent runs with identical formatting to optimize the output document's content.
  // This may affect the appearance of the document.
  // Set the "OptimizeOutput" property to "false" to save the document normally.
  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.

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

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

  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);
  
      String[] filePaths = DocumentHelper.directoryGetFiles(getArtifactsDir(), "SavingCallback.PageFileNames.Page_*").toArray(new String[0]);
  
      Assert.assertEquals(3, filePaths.length);
  }
  
  /// <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:
          try (FileOutputStream outputStream = new FileOutputStream(outFileName)) {
              args.setPageStream(outputStream);
          }
  
          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 extract pages based on exact page indices.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Add five pages to the document.
  for (int i = 1; i < 6; i++) {
      builder.write("Page " + i);
      builder.insertBreak(BreakType.PAGE_BREAK);
  }
  
  // Create an "XpsSaveOptions" object, which we can pass to the document's "Save" method
  // to modify how that method converts the document to .XPS.
  XpsSaveOptions xpsOptions = new XpsSaveOptions();
  
  // Use the "PageSet" property to select a set of the document's pages to save to output XPS.
  // In this case, we will choose, via a zero-based index, only three pages: page 1, page 2, and page 4.
  xpsOptions.setPageSet(new PageSet(0, 1, 3));
  
  doc.save(getArtifactsDir() + "XpsSaveOptions.ExportExactPages.xps", xpsOptions);

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

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

  Editable forms are prohibited by PDF/A compliance. false value will be used automatically when saving to PDF/A.

  Form fields are not supported when saving to PDF/UA. false value will be used automatically.

• 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);

• getProgressCallback/setProgressCallback

  public IDocumentSavingCallback getProgressCallback() / public void setProgressCallback(IDocumentSavingCallback value)
  

  Called during saving a document and accepts data about saving progress.

  Progress is reported when saving to SaveFormat.DOCX, SaveFormat.FLAT_OPC, SaveFormat.DOCM, SaveFormat.DOTM, SaveFormat.DOTX, SaveFormat.HTML, SaveFormat.MHTML, SaveFormat.EPUB, SaveFormat.XAML_FLOW, or SaveFormat.XAML_FLOW_PACK.

  Example:

  Shows how to manage a document while saving to xamlflow.

  public void progressCallback(int saveFormat, String ext) throws Exception
  {
      Document doc = new Document(getMyDir() + "Big document.docx");
  
      // Following formats are supported: XamlFlow, XamlFlowPack.
      XamlFlowSaveOptions saveOptions = new XamlFlowSaveOptions(saveFormat);
      {
          saveOptions.setProgressCallback(new SavingProgressCallback());
      }
  
      try {
          doc.save(getArtifactsDir() + MessageFormat.format("XamlFlowSaveOptions.ProgressCallback.{0}", ext), saveOptions);
      }
      catch (IllegalStateException exception) {
          Assert.assertTrue(exception.getMessage().contains("EstimatedProgress"));
      }
  }
  
  @DataProvider(name = "progressCallbackDataProvider")
  public static Object[][] progressCallbackDataProvider() throws Exception
  {
      return new Object[][]
              {
                      {SaveFormat.XAML_FLOW,  "xamlflow"},
                      {SaveFormat.XAML_FLOW_PACK,  "xamlflowpack"},
              };
  }
  
  /// <summary>
  /// Saving progress callback. Cancel a document saving after the "MaxDuration" seconds.
  /// </summary>
  public static class SavingProgressCallback implements IDocumentSavingCallback
  {
      /// <summary>
      /// Ctr.
      /// </summary>
      public SavingProgressCallback()
      {
          mSavingStartedAt = new Date();
      }
  
      /// <summary>
      /// Callback method which called during document saving.
      /// </summary>
      /// <param name="args">Saving arguments.</param>
      public void notify(DocumentSavingArgs args)
      {
          Date canceledAt = new Date();
          long diff = canceledAt.getTime() - mSavingStartedAt.getTime();
          long ellapsedSeconds = TimeUnit.MILLISECONDS.toSeconds(diff);
  
          if (ellapsedSeconds > MAX_DURATION)
              throw new IllegalStateException(MessageFormat.format("EstimatedProgress = {0}; CanceledAt = {1}", args.getEstimatedProgress(), canceledAt));
      }
  
      /// <summary>
      /// Date and time when document saving is started.
      /// </summary>
      private Date mSavingStartedAt;
  
      /// <summary>
      /// Maximum allowed duration in sec.
      /// </summary>
      private static final double MAX_DURATION = 0.01d;
  }

  Example:

  Shows how to manage a document while saving to html.

  public void progressCallback(int saveFormat, String ext) throws Exception
  {
      Document doc = new Document(getMyDir() + "Big document.docx");
  
      // Following formats are supported: Html, Mhtml, Epub.
      HtmlSaveOptions saveOptions = new HtmlSaveOptions(saveFormat);
      {
          saveOptions.setProgressCallback(new SavingProgressCallback());
      }
  
      try {
          doc.save(getArtifactsDir() + MessageFormat.format("HtmlSaveOptions.ProgressCallback.{0}", ext), saveOptions);
      }
      catch (IllegalStateException exception) {
          Assert.assertTrue(exception.getMessage().contains("EstimatedProgress"));
      }
  
  }
  
  @DataProvider(name = "progressCallbackDataProvider")
  public static Object[][] progressCallbackDataProvider() throws Exception
  {
      return new Object[][]
              {
                      {SaveFormat.HTML,  "html"},
                      {SaveFormat.MHTML,  "mhtml"},
                      {SaveFormat.EPUB,  "epub"},
              };
  }
  
  /// <summary>
  /// Saving progress callback. Cancel a document saving after the "MaxDuration" seconds.
  /// </summary>
  public static class SavingProgressCallback implements IDocumentSavingCallback
  {
      /// <summary>
      /// Ctr.
      /// </summary>
      public SavingProgressCallback()
      {
          mSavingStartedAt = new Date();
      }
  
      /// <summary>
      /// Callback method which called during document saving.
      /// </summary>
      /// <param name="args">Saving arguments.</param>
      public void notify(DocumentSavingArgs args)
      {
          Date canceledAt = new Date();
          long diff = canceledAt.getTime() - mSavingStartedAt.getTime();
          long ellapsedSeconds = TimeUnit.MILLISECONDS.toSeconds(diff);
  
          if (ellapsedSeconds > MAX_DURATION)
              throw new IllegalStateException(MessageFormat.format("EstimatedProgress = {0}; CanceledAt = {1}", args.getEstimatedProgress(), canceledAt));
      }
  
      /// <summary>
      /// Date and time when document saving is started.
      /// </summary>
      private Date mSavingStartedAt;
  
      /// <summary>
      /// Maximum allowed duration in sec.
      /// </summary>
      private static final double MAX_DURATION = 0.01d;
  }

  Example:

  Shows how to manage a document while saving to docx.

  public void progressCallback(int saveFormat, String ext) throws Exception
  {
      Document doc = new Document(getMyDir() + "Big document.docx");
  
      // Following formats are supported: Docx, FlatOpc, Docm, Dotm, Dotx.
      OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(saveFormat);
      {
          saveOptions.setProgressCallback(new SavingProgressCallback());
      }
  
      try {
          doc.save(getArtifactsDir() + MessageFormat.format("OoxmlSaveOptions.ProgressCallback.{0}", ext), saveOptions);
      }
      catch (IllegalStateException exception) {
          Assert.assertTrue(exception.getMessage().contains("EstimatedProgress"));
      }
  }
  
  @DataProvider(name = "progressCallbackDataProvider")
  public static Object[][] progressCallbackDataProvider() throws Exception
  {
      return new Object[][]
              {
                      {SaveFormat.DOCX,  "docx"},
                      {SaveFormat.DOCM,  "docm"},
                      {SaveFormat.DOTM,  "dotm"},
                      {SaveFormat.DOTX,  "dotx"},
                      {SaveFormat.FLAT_OPC,  "flatopc"},
              };
  }
  
  /// <summary>
  /// Saving progress callback. Cancel a document saving after the "MaxDuration" seconds.
  /// </summary>
  public static class SavingProgressCallback implements IDocumentSavingCallback
  {
      /// <summary>
      /// Ctr.
      /// </summary>
      public SavingProgressCallback()
      {
          mSavingStartedAt = new Date();
      }
  
      /// <summary>
      /// Callback method which called during document saving.
      /// </summary>
      /// <param name="args">Saving arguments.</param>
      public void notify(DocumentSavingArgs args)
      {
          Date canceledAt = new Date();
          long diff = canceledAt.getTime() - mSavingStartedAt.getTime();
          long ellapsedSeconds = TimeUnit.MILLISECONDS.toSeconds(diff);
  
          if (ellapsedSeconds > MAX_DURATION)
              throw new IllegalStateException(MessageFormat.format("EstimatedProgress = {0}; CanceledAt = {1}", args.getEstimatedProgress(), canceledAt));
      }
  
      /// <summary>
      /// Date and time when document saving is started.
      /// </summary>
      private Date mSavingStartedAt;
  
      /// <summary>
      /// Maximum allowed duration in sec.
      /// </summary>
      private static final double MAX_DURATION = 0.01d;
  }

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

• 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 java.lang.IndexOutOfBoundsException. 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.

• getUpdateCreatedTimeProperty/setUpdateCreatedTimeProperty

  public boolean getUpdateCreatedTimeProperty() / public void setUpdateCreatedTimeProperty(boolean value)
  

  Gets or sets a value determining whether the BuiltInDocumentProperties.CreatedTime property is updated before saving. Default value is false;

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

• 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 "CreatedTime" property when saving.

  Document doc = new Document();
  
  Calendar calendar = Calendar.getInstance();
  calendar.set(2019, 11, 20);
  doc.getBuiltInDocumentProperties().setCreatedTime(calendar.getTime());
  
  // This flag determines whether the created time, 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 created time.
  DocSaveOptions saveOptions = new DocSaveOptions();
  saveOptions.setUpdateCreatedTimeProperty(isUpdateCreatedTimeProperty);
  
  doc.save(getArtifactsDir() + "DocSaveOptions.UpdateCreatedTimeProperty.docx", saveOptions);

  Example:

  Shows how to update a document's "Last printed" property when saving.

  Document doc = new Document();
  
  Calendar calendar = Calendar.getInstance();
  calendar.set(2019, 11, 20);
  doc.getBuiltInDocumentProperties().setLastPrinted(calendar.getTime());
  
  // 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);

• 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 to update structured document tags while saving a document to PDF.

  Document doc = new Document();
  
  // Insert a drop-down list structured document tag.
  StructuredDocumentTag 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"));
  
  // The drop-down list currently displays "Choose an item" as the default text.
  // Set the "SelectedValue" property to one of the list items to get the tag to
  // display that list item's value instead of the default text.
  tag.getListItems().setSelectedValue(tag.getListItems().get(1));
  
  doc.getFirstSection().getBody().appendChild(tag);
  
  // Create a "PdfSaveOptions" object to pass to the document's "Save" method
  // to modify how that method saves the document to .PDF.
  PdfSaveOptions options = new PdfSaveOptions();
  
  // Set the "UpdateSdtContent" property to "false" not to update the structured document tags
  // while saving the document to PDF. They will display their default values as they were at the time of construction.
  // Set the "UpdateSdtContent" property to "true" to make sure the tags display updated values in the PDF.
  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.

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

  PDF/A and PDF/UA compliance requires all fonts to be embedded. false value will be used automatically when saving to PDF/A and PDF/UA.

  Core fonts are not supported when saving to PDF 2.0 format. false value will be used automatically when saving to PDF 2.0.

  This option has a higher priority then FontEmbeddingMode option.

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

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

Method Detail

• deepClone

  public PdfSaveOptions deepClone()

  Creates a deep clone of this object.

• equals

  public boolean equals(java.lang.Object obj)

  Determines whether the specified object is equal in value to the current object.