com.aspose.words

Constructor Detail

• OoxmlSaveOptions

  public OoxmlSaveOptions()

  Initializes a new instance of this class that can be used to save a document in the SaveFormat.DOCX format.

  Example:

  Shows how to set an OOXML compliance specification for a saved document to adhere to.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // If we configure compatibility options to comply with Microsoft Word 2003,
  // inserting an image will define its shape using VML.
  doc.getCompatibilityOptions().optimizeFor(MsWordVersion.WORD_2003);
  builder.insertImage(getImageDir() + "Transparent background logo.png");
  
  Assert.assertEquals(ShapeMarkupLanguage.VML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage());
  
  // The "ISO/IEC 29500:2008" OOXML standard does not support VML shapes.
  // If we set the "Compliance" property of the SaveOptions object to "OoxmlCompliance.Iso29500_2008_Strict",
  // any document we save while passing this object will have to follow that standard. 
  OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
  saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT);
  saveOptions.setSaveFormat(SaveFormat.DOCX);
  
  doc.save(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx", saveOptions);
  
  // Our saved document defines the shape using DML to adhere to the "ISO/IEC 29500:2008" OOXML standard.
  doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx");
  
  Assert.assertEquals(ShapeMarkupLanguage.DML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage());

• OoxmlSaveOptions

  public OoxmlSaveOptions(int saveFormat)

  Initializes a new instance of this class that can be used to save a document in the SaveFormat.DOCX, SaveFormat.DOCM, SaveFormat.DOTX, SaveFormat.DOTM or SaveFormat.FLAT_OPC format.

  Parameters:

  saveFormat - A SaveFormat value. Can be SaveFormat.DOCX, SaveFormat.DOCM, SaveFormat.DOTX, SaveFormat.DOTM or SaveFormat.FLAT_OPC.

  Example:

  Shows how to support legacy control characters when converting to .docx.

  Document doc = new Document(getMyDir() + "Legacy control character.doc");
  
  // 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 "KeepLegacyControlChars" property to "true" to preserve
  // the "ShortDateTime" legacy character while saving.
  // Set the "KeepLegacyControlChars" property to "false" to remove
  // the "ShortDateTime" legacy character from the output document.
  OoxmlSaveOptions so = new OoxmlSaveOptions(SaveFormat.DOCX);
  so.setKeepLegacyControlChars(keepLegacyControlChars);
  
  doc.save(getArtifactsDir() + "OoxmlSaveOptions.KeepLegacyControlChars.docx", so);
  
  doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.KeepLegacyControlChars.docx");
  
  if (keepLegacyControlChars)
      Assert.assertEquals("\u0013date \\@ \"M/d/yyyy\"\u0014\u0015\f", doc.getFirstSection().getBody().getText());
  else
      Assert.assertEquals("\u001e\f", doc.getFirstSection().getBody().getText());

Property Getters/Setters Detail

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

• getCompliance/setCompliance

  public int getCompliance() / public void setCompliance(int value)
  

  Specifies the OOXML version for the output document. The default value is OoxmlCompliance.ECMA_376_2006. The value of the property is OoxmlCompliance integer constant.

  Example:

  Shows how to insert DML shapes into a document.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Below are two wrapping types that shapes may have.
  // 1 -  Floating:
  builder.insertShape(ShapeType.TOP_CORNERS_ROUNDED, RelativeHorizontalPosition.PAGE, 100.0,
          RelativeVerticalPosition.PAGE, 100.0, 50.0, 50.0, WrapType.NONE);
  
  // 2 -  Inline:
  builder.insertShape(ShapeType.DIAGONAL_CORNERS_ROUNDED, 50.0, 50.0);
  
  // If you need to create "non-primitive" shapes, such as SingleCornerSnipped, TopCornersSnipped, DiagonalCornersSnipped,
  // TopCornersOneRoundedOneSnipped, SingleCornerRounded, TopCornersRounded, or DiagonalCornersRounded,
  // then save the document with "Strict" or "Transitional" compliance, which allows saving shape as DML.
  OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(SaveFormat.DOCX);
  saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_TRANSITIONAL);
  
  doc.save(getArtifactsDir() + "Shape.ShapeInsertion.docx", saveOptions);

  Example:

  Shows how to configure a list to restart numbering at each section.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  doc.getLists().add(ListTemplate.NUMBER_DEFAULT);
  
  List list = doc.getLists().get(0);
  list.isRestartAtEachSection(restartListAtEachSection);
  
  // The "IsRestartAtEachSection" property will only be applicable when
  // the document's OOXML compliance level is to a standard that is newer than "OoxmlComplianceCore.Ecma376".
  OoxmlSaveOptions options = new OoxmlSaveOptions();
  {
      options.setCompliance(OoxmlCompliance.ISO_29500_2008_TRANSITIONAL);
  }
  
  builder.getListFormat().setList(list);
  
  builder.writeln("List item 1");
  builder.writeln("List item 2");
  builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
  builder.writeln("List item 3");
  builder.writeln("List item 4");
  
  doc.save(getArtifactsDir() + "OoxmlSaveOptions.RestartingDocumentList.docx", options);
  
  doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.RestartingDocumentList.docx");
  
  Assert.assertEquals(restartListAtEachSection, doc.getLists().get(0).isRestartAtEachSection());

  Example:

  Shows how to set an OOXML compliance specification for a saved document to adhere to.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // If we configure compatibility options to comply with Microsoft Word 2003,
  // inserting an image will define its shape using VML.
  doc.getCompatibilityOptions().optimizeFor(MsWordVersion.WORD_2003);
  builder.insertImage(getImageDir() + "Transparent background logo.png");
  
  Assert.assertEquals(ShapeMarkupLanguage.VML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage());
  
  // The "ISO/IEC 29500:2008" OOXML standard does not support VML shapes.
  // If we set the "Compliance" property of the SaveOptions object to "OoxmlCompliance.Iso29500_2008_Strict",
  // any document we save while passing this object will have to follow that standard. 
  OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
  saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT);
  saveOptions.setSaveFormat(SaveFormat.DOCX);
  
  doc.save(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx", saveOptions);
  
  // Our saved document defines the shape using DML to adhere to the "ISO/IEC 29500:2008" OOXML standard.
  doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx");
  
  Assert.assertEquals(ShapeMarkupLanguage.DML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage());

• getCompressionLevel/setCompressionLevel

  public int getCompressionLevel() / public void setCompressionLevel(int value)
  

  Specifies the compression level used to save document. The default value is CompressionLevel.NORMAL. The value of the property is CompressionLevel integer constant.

  Example:

  Shows how to specify the compression level to use while saving an OOXML document.

  Document doc = new Document(getMyDir() + "Big 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 "CompressionLevel" property to "CompressionLevel.Maximum" to apply the strongest and slowest compression.
  // Set the "CompressionLevel" property to "CompressionLevel.Normal" to apply
  // the default compression that Aspose.Words uses while saving OOXML documents.
  // Set the "CompressionLevel" property to "CompressionLevel.Fast" to apply a faster and weaker compression.
  // Set the "CompressionLevel" property to "CompressionLevel.SuperFast" to apply
  // the default compression that Microsoft Word uses.
  OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(SaveFormat.DOCX);
  saveOptions.setCompressionLevel(compressionLevel);
  
  StopWatch st = new StopWatch();
  st.start();
  doc.save(getArtifactsDir() + "OoxmlSaveOptions.DocumentCompression.docx", saveOptions);
  st.stop();
  
  File fileInfo = new File(getArtifactsDir() + "OoxmlSaveOptions.DocumentCompression.docx");
  
  System.out.println(MessageFormat.format("Saving operation done using the \"{0}\" compression level:", compressionLevel));
  System.out.println(MessageFormat.format("\tDuration:\t{0}", st.getTime()));
  System.out.println(MessageFormat.format("\tFile Size:\t{0} bytes", fileInfo.length()));

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

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

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

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

• getFlatOpcXmlMappingOnly/setFlatOpcXmlMappingOnly

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

  Deprecated. 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);

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

• getKeepLegacyControlChars/setKeepLegacyControlChars

  public boolean getKeepLegacyControlChars() / public void setKeepLegacyControlChars(boolean value)
  

  Keeps original representation of legacy control characters.

  Example:

  Shows how to support legacy control characters when converting to .docx.

  Document doc = new Document(getMyDir() + "Legacy control character.doc");
  
  // 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 "KeepLegacyControlChars" property to "true" to preserve
  // the "ShortDateTime" legacy character while saving.
  // Set the "KeepLegacyControlChars" property to "false" to remove
  // the "ShortDateTime" legacy character from the output document.
  OoxmlSaveOptions so = new OoxmlSaveOptions(SaveFormat.DOCX);
  so.setKeepLegacyControlChars(keepLegacyControlChars);
  
  doc.save(getArtifactsDir() + "OoxmlSaveOptions.KeepLegacyControlChars.docx", so);
  
  doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.KeepLegacyControlChars.docx");
  
  if (keepLegacyControlChars)
      Assert.assertEquals("\u0013date \\@ \"M/d/yyyy\"\u0014\u0015\f", doc.getFirstSection().getBody().getText());
  else
      Assert.assertEquals("\u001e\f", doc.getFirstSection().getBody().getText());

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

• getPassword/setPassword

  public java.lang.String getPassword() / public void setPassword(java.lang.String value)
  

  Gets/sets a password to encrypt document using ECMA376 Standard encryption algorithm.

  In order to save document without encryption this property should be null or empty string.

  Example:

  Shows how to create a password encrypted Office Open XML document.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.writeln("Hello world!");
  
  OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
  saveOptions.setPassword("MyPassword");
  
  doc.save(getArtifactsDir() + "OoxmlSaveOptions.Password.docx", saveOptions);
  
  // We will not be able to open this document with Microsoft Word or
  // Aspose.Words without providing the correct password.
  Assert.assertThrows(IncorrectPasswordException.class, () -> new Document(getArtifactsDir() + "OoxmlSaveOptions.Password.docx"));
  
  // Open the encrypted document by passing the correct password in a LoadOptions object.
  doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.Password.docx", new LoadOptions("MyPassword"));
  
  Assert.assertEquals("Hello world!", doc.getText().trim());

• 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 be SaveFormat.DOCX, SaveFormat.DOCM, SaveFormat.DOTX, SaveFormat.DOTM or SaveFormat.FLAT_OPC. The value of the property is SaveFormat integer constant.

  Example:

  Shows how to set an OOXML compliance specification for a saved document to adhere to.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // If we configure compatibility options to comply with Microsoft Word 2003,
  // inserting an image will define its shape using VML.
  doc.getCompatibilityOptions().optimizeFor(MsWordVersion.WORD_2003);
  builder.insertImage(getImageDir() + "Transparent background logo.png");
  
  Assert.assertEquals(ShapeMarkupLanguage.VML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage());
  
  // The "ISO/IEC 29500:2008" OOXML standard does not support VML shapes.
  // If we set the "Compliance" property of the SaveOptions object to "OoxmlCompliance.Iso29500_2008_Strict",
  // any document we save while passing this object will have to follow that standard. 
  OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
  saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT);
  saveOptions.setSaveFormat(SaveFormat.DOCX);
  
  doc.save(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx", saveOptions);
  
  // Our saved document defines the shape using DML to adhere to the "ISO/IEC 29500:2008" OOXML standard.
  doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx");
  
  Assert.assertEquals(ShapeMarkupLanguage.DML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage());

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

• 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, SaveFormat.EPUB and SaveFormat.AZW_3 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);

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