com.aspose.words

Constructor Detail

• HtmlSaveOptions

  public HtmlSaveOptions()

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

  Example:

  Shows how to use a specific encoding when saving a document to .epub.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // Use a SaveOptions object to specify the encoding for a document that we will save.
  HtmlSaveOptions saveOptions = new HtmlSaveOptions();
  saveOptions.setSaveFormat(SaveFormat.EPUB);
  saveOptions.setEncoding(StandardCharsets.UTF_8);
  
  // By default, an output .epub document will have all of its contents in one HTML part.
  // A split criterion allows us to segment the document into several HTML parts.
  // We will set the criteria to split the document into heading paragraphs.
  // This is useful for readers who cannot read HTML files more significant than a specific size.
  saveOptions.setDocumentSplitCriteria(DocumentSplitCriteria.HEADING_PARAGRAPH);
  
  // Specify that we want to export document properties.
  saveOptions.setExportDocumentProperties(true);
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.Doc2EpubSaveOptions.epub", saveOptions);

• HtmlSaveOptions

  public HtmlSaveOptions(int saveFormat)

  Initializes a new instance of this class that can be used to save a document in the SaveFormat.HTML, SaveFormat.MHTML or SaveFormat.EPUB format.

  Parameters:

  saveFormat - A SaveFormat value. Can be SaveFormat.HTML, SaveFormat.MHTML or SaveFormat.EPUB.

  Example:

  Shows how to save a document to a specific version of HTML.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  HtmlSaveOptions options = new HtmlSaveOptions(SaveFormat.HTML);
  {
      options.setHtmlVersion(htmlVersion);
      options.setPrettyFormat(true);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.HtmlVersions.html", options);
  
  // Our HTML documents will have minor differences to be compatible with different HTML versions.
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.HtmlVersions.html"), StandardCharsets.UTF_8);
  
  switch (htmlVersion) {
      case HtmlVersion.HTML_5:
          Assert.assertTrue(outDocContents.contains("<a id=\"_Toc76372689\"></a>"));
          Assert.assertTrue(outDocContents.contains("<a id=\"_Toc76372689\"></a>"));
          Assert.assertTrue(outDocContents.contains("<table style=\"-aw-border-insideh:0.5pt single #000000; -aw-border-insidev:0.5pt single #000000; border-collapse:collapse\">"));
          break;
      case HtmlVersion.XHTML:
          Assert.assertTrue(outDocContents.contains("<a name=\"_Toc76372689\"></a>"));
          Assert.assertTrue(outDocContents.contains("<ul type=\"disc\" style=\"margin:0pt; padding-left:0pt\">"));
          Assert.assertTrue(outDocContents.contains("<table cellspacing=\"0\" cellpadding=\"0\" style=\"-aw-border-insideh:0.5pt single #000000; -aw-border-insidev:0.5pt single #000000; border-collapse:collapse\">"));
          break;
  }

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

• getAllowNegativeIndent/setAllowNegativeIndent

  public boolean getAllowNegativeIndent() / public void setAllowNegativeIndent(boolean value)
  

  Specifies whether negative left and right indents of paragraphs are normalized when saving to HTML, MHTML or EPUB. Default value is false.

  When negative indent is not allowed, it is exported as zero margin to HTML. When negative indent is allowed, a paragraph might appear partially outside of the browser window.

  Example:

  Shows how to preserve negative indents in the output .html.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert a table with a negative indent, which will push it to the left past the left page boundary.
  Table table = builder.startTable();
  builder.insertCell();
  builder.write("Row 1, Cell 1");
  builder.insertCell();
  builder.write("Row 1, Cell 2");
  builder.endTable();
  table.setLeftIndent(-36);
  table.setPreferredWidth(PreferredWidth.fromPoints(144.0));
  
  builder.insertBreak(BreakType.PARAGRAPH_BREAK);
  
  // Insert a table with a positive indent, which will push the table to the right.
  table = builder.startTable();
  builder.insertCell();
  builder.write("Row 1, Cell 1");
  builder.insertCell();
  builder.write("Row 1, Cell 2");
  builder.endTable();
  table.setLeftIndent(36.0);
  table.setPreferredWidth(PreferredWidth.fromPoints(144.0));
  
  // When we save a document to HTML, Aspose.Words will only preserve negative indents
  // such as the one we have applied to the first table if we set the "AllowNegativeIndent" flag
  // in a SaveOptions object that we will pass to "true".
  HtmlSaveOptions options = new HtmlSaveOptions(SaveFormat.HTML);
  {
      options.setAllowNegativeIndent(allowNegativeIndent);
      options.setTableWidthOutputMode(HtmlElementSizeOutputMode.RELATIVE_ONLY);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.NegativeIndent.html", options);
  
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.NegativeIndent.html"), StandardCharsets.UTF_8);
  
  if (allowNegativeIndent) {
      Assert.assertTrue(outDocContents.contains(
              "<table cellspacing=\"0\" cellpadding=\"0\" style=\"margin-left:-41.65pt; border:0.75pt solid #000000; -aw-border:0.5pt single; -aw-border-insideh:0.5pt single #000000; -aw-border-insidev:0.5pt single #000000; border-collapse:collapse\">"));
      Assert.assertTrue(outDocContents.contains(
              "<table cellspacing=\"0\" cellpadding=\"0\" style=\"margin-left:30.35pt; border:0.75pt solid #000000; -aw-border:0.5pt single; -aw-border-insideh:0.5pt single #000000; -aw-border-insidev:0.5pt single #000000; border-collapse:collapse\">"));
  } else {
      Assert.assertTrue(outDocContents.contains(
              "<table cellspacing=\"0\" cellpadding=\"0\" style=\"border:0.75pt solid #000000; -aw-border:0.5pt single; -aw-border-insideh:0.5pt single #000000; -aw-border-insidev:0.5pt single #000000; border-collapse:collapse\">"));
      Assert.assertTrue(outDocContents.contains(
              "<table cellspacing=\"0\" cellpadding=\"0\" style=\"margin-left:30.35pt; border:0.75pt solid #000000; -aw-border:0.5pt single; -aw-border-insideh:0.5pt single #000000; -aw-border-insidev:0.5pt single #000000; border-collapse:collapse\">"));
  }

• getCssClassNamePrefix/setCssClassNamePrefix

  public java.lang.String getCssClassNamePrefix() / public void setCssClassNamePrefix(java.lang.String value)
  

  Specifies a prefix which is added to all CSS class names. Default value is an empty string and generated CSS class names have no common prefix.

  If this value is not empty, all CSS classes generated by Aspose.Words will start with the specified prefix. This might be useful, for example, if you add custom CSS to generated documents and want to prevent class name conflicts.

  If the value is not null or empty, it must be a valid CSS identifier.

  Example:

  Shows how to save a document to HTML, and add a prefix to all of its CSS class names.

  Document doc = new Document(getMyDir() + "Paragraphs.docx");
  
  HtmlSaveOptions saveOptions = new HtmlSaveOptions();
  {
      saveOptions.setCssStyleSheetType(CssStyleSheetType.EXTERNAL);
      saveOptions.setCssClassNamePrefix("myprefix-");
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.CssClassNamePrefix.html", saveOptions);
  
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.CssClassNamePrefix.html"), StandardCharsets.UTF_8);
  
  Assert.assertTrue(outDocContents.contains("<p class=\"myprefix-Header\">"));
  Assert.assertTrue(outDocContents.contains("<p class=\"myprefix-Footer\">"));
  
  outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.CssClassNamePrefix.css"), StandardCharsets.UTF_8);
  
  Assert.assertTrue(outDocContents.contains(".myprefix-Footer { margin-bottom:0pt; line-height:normal; font-family:Arial; font-size:11pt }\r\n" +
          ".myprefix-Header { margin-bottom:0pt; line-height:normal; font-family:Arial; font-size:11pt }\r\n"));

• getCssSavingCallback/setCssSavingCallback

  public ICssSavingCallback getCssSavingCallback() / public void setCssSavingCallback(ICssSavingCallback value)
  

  Allows to control how CSS styles are saved when a document is saved to HTML, MHTML or EPUB.

  Example:

  Shows how to work with CSS stylesheets that an HTML conversion creates.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
      // Create an "HtmlFixedSaveOptions" object, which we can pass to the document's "Save" method
      // to modify how we convert the document to HTML.
      HtmlSaveOptions options = new HtmlSaveOptions();
  
      // Set the "CssStylesheetType" property to "CssStyleSheetType.External" to
      // accompany a saved HTML document with an external CSS stylesheet file.
      options.setCssStyleSheetType(CssStyleSheetType.EXTERNAL);
  
      // Below are two ways of specifying directories and filenames for output CSS stylesheets.
      // 1 -  Use the "CssStyleSheetFileName" property to assign a filename to our stylesheet:
      options.setCssStyleSheetFileName(getArtifactsDir() + "SavingCallback.ExternalCssFilenames.css");
  
      // 2 -  Use a custom callback to name our stylesheet:
      options.setCssSavingCallback(new CustomCssSavingCallback(getArtifactsDir() + "SavingCallback.ExternalCssFilenames.css", true, false));
  
      doc.save(getArtifactsDir() + "SavingCallback.ExternalCssFilenames.html", options);
  }
  
  /// <summary>
  /// Sets a custom filename, along with other parameters for an external CSS stylesheet.
  /// </summary>
  private static class CustomCssSavingCallback implements ICssSavingCallback {
      public CustomCssSavingCallback(String cssDocFilename, boolean isExportNeeded, boolean keepCssStreamOpen) {
          mCssTextFileName = cssDocFilename;
          mIsExportNeeded = isExportNeeded;
          mKeepCssStreamOpen = keepCssStreamOpen;
      }
  
      public void cssSaving(CssSavingArgs args) throws Exception {
          // We can access the entire source document via the "Document" property.
          Assert.assertTrue(args.getDocument().getOriginalFileName().endsWith("Rendering.docx"));
  
          args.setCssStream(new FileOutputStream(mCssTextFileName));
          args.isExportNeeded(mIsExportNeeded);
          args.setKeepCssStreamOpen(mKeepCssStreamOpen);
      }
  
      private final String mCssTextFileName;
      private final boolean mIsExportNeeded;
      private final boolean mKeepCssStreamOpen;
  }

• getCssStyleSheetFileName/setCssStyleSheetFileName

  public java.lang.String getCssStyleSheetFileName() / public void setCssStyleSheetFileName(java.lang.String value)
  

  Specifies the path and the name of the Cascading Style Sheet (CSS) file written when a document is exported to HTML. Default is an empty string.

  This property has effect only when saving a document to HTML format and external CSS style sheet is requested using CssStyleSheetType.

  If this property is empty, the CSS file will be saved into the same folder and with the same name as the HTML document but with the ".css" extension.

  If only path but no file name is specified in this property, the CSS file will be saved into the specified folder and will have the same name as the HTML document but with the ".css" extension.

  If the folder specified by this property doesn't exist, it will be created automatically before the CSS file is saved.

  Another way to specify a folder where external CSS file is saved is to use ResourceFolder.

  Example:

  Shows how to work with CSS stylesheets that an HTML conversion creates.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
      // Create an "HtmlFixedSaveOptions" object, which we can pass to the document's "Save" method
      // to modify how we convert the document to HTML.
      HtmlSaveOptions options = new HtmlSaveOptions();
  
      // Set the "CssStylesheetType" property to "CssStyleSheetType.External" to
      // accompany a saved HTML document with an external CSS stylesheet file.
      options.setCssStyleSheetType(CssStyleSheetType.EXTERNAL);
  
      // Below are two ways of specifying directories and filenames for output CSS stylesheets.
      // 1 -  Use the "CssStyleSheetFileName" property to assign a filename to our stylesheet:
      options.setCssStyleSheetFileName(getArtifactsDir() + "SavingCallback.ExternalCssFilenames.css");
  
      // 2 -  Use a custom callback to name our stylesheet:
      options.setCssSavingCallback(new CustomCssSavingCallback(getArtifactsDir() + "SavingCallback.ExternalCssFilenames.css", true, false));
  
      doc.save(getArtifactsDir() + "SavingCallback.ExternalCssFilenames.html", options);
  }
  
  /// <summary>
  /// Sets a custom filename, along with other parameters for an external CSS stylesheet.
  /// </summary>
  private static class CustomCssSavingCallback implements ICssSavingCallback {
      public CustomCssSavingCallback(String cssDocFilename, boolean isExportNeeded, boolean keepCssStreamOpen) {
          mCssTextFileName = cssDocFilename;
          mIsExportNeeded = isExportNeeded;
          mKeepCssStreamOpen = keepCssStreamOpen;
      }
  
      public void cssSaving(CssSavingArgs args) throws Exception {
          // We can access the entire source document via the "Document" property.
          Assert.assertTrue(args.getDocument().getOriginalFileName().endsWith("Rendering.docx"));
  
          args.setCssStream(new FileOutputStream(mCssTextFileName));
          args.isExportNeeded(mIsExportNeeded);
          args.setKeepCssStreamOpen(mKeepCssStreamOpen);
      }
  
      private final String mCssTextFileName;
      private final boolean mIsExportNeeded;
      private final boolean mKeepCssStreamOpen;
  }

  See Also:

  ResourceFolder, ResourceFolderAlias, CssStyleSheetType

• getCssStyleSheetType/setCssStyleSheetType

  public int getCssStyleSheetType() / public void setCssStyleSheetType(int value)
  

  Specifies how CSS (Cascading Style Sheet) styles are exported to HTML, MHTML or EPUB. Default value is CssStyleSheetType.INLINE for HTML/MHTML and CssStyleSheetType.EXTERNAL for EPUB. The value of the property is CssStyleSheetType integer constant.

  Saving CSS style sheet into an external file is only supported when saving to HTML. When you are exporting to one of the container formats (EPUB or MHTML) and specifying CssStyleSheetType.EXTERNAL, CSS file will be encapsulated into the output package.

  Example:

  Shows how to work with CSS stylesheets that an HTML conversion creates.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
      // Create an "HtmlFixedSaveOptions" object, which we can pass to the document's "Save" method
      // to modify how we convert the document to HTML.
      HtmlSaveOptions options = new HtmlSaveOptions();
  
      // Set the "CssStylesheetType" property to "CssStyleSheetType.External" to
      // accompany a saved HTML document with an external CSS stylesheet file.
      options.setCssStyleSheetType(CssStyleSheetType.EXTERNAL);
  
      // Below are two ways of specifying directories and filenames for output CSS stylesheets.
      // 1 -  Use the "CssStyleSheetFileName" property to assign a filename to our stylesheet:
      options.setCssStyleSheetFileName(getArtifactsDir() + "SavingCallback.ExternalCssFilenames.css");
  
      // 2 -  Use a custom callback to name our stylesheet:
      options.setCssSavingCallback(new CustomCssSavingCallback(getArtifactsDir() + "SavingCallback.ExternalCssFilenames.css", true, false));
  
      doc.save(getArtifactsDir() + "SavingCallback.ExternalCssFilenames.html", options);
  }
  
  /// <summary>
  /// Sets a custom filename, along with other parameters for an external CSS stylesheet.
  /// </summary>
  private static class CustomCssSavingCallback implements ICssSavingCallback {
      public CustomCssSavingCallback(String cssDocFilename, boolean isExportNeeded, boolean keepCssStreamOpen) {
          mCssTextFileName = cssDocFilename;
          mIsExportNeeded = isExportNeeded;
          mKeepCssStreamOpen = keepCssStreamOpen;
      }
  
      public void cssSaving(CssSavingArgs args) throws Exception {
          // We can access the entire source document via the "Document" property.
          Assert.assertTrue(args.getDocument().getOriginalFileName().endsWith("Rendering.docx"));
  
          args.setCssStream(new FileOutputStream(mCssTextFileName));
          args.isExportNeeded(mIsExportNeeded);
          args.setKeepCssStreamOpen(mKeepCssStreamOpen);
      }
  
      private final String mCssTextFileName;
      private final boolean mIsExportNeeded;
      private final boolean mKeepCssStreamOpen;
  }

  See Also:

  CssStyleSheetFileName

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

• getDocumentPartSavingCallback/setDocumentPartSavingCallback

  public IDocumentPartSavingCallback getDocumentPartSavingCallback() / public void setDocumentPartSavingCallback(IDocumentPartSavingCallback value)
  

  Allows to control how document parts are saved when a document is saved to HTML or EPUB.

  Example:

  Shows how to split a document into parts and save them.

  Document doc = new Document(getMyDir() + "Rendering.docx");
      String outFileName = "SavingCallback.DocumentPartsFileNames.html";
  
      // Create an "HtmlFixedSaveOptions" object, which we can pass to the document's "Save" method
      // to modify how we convert the document to HTML.
      HtmlSaveOptions options = new HtmlSaveOptions();
  
      // If we save the document normally, there will be one output HTML
      // document with all the source document's contents.
      // Set the "DocumentSplitCriteria" property to "DocumentSplitCriteria.SectionBreak" to
      // save our document to multiple HTML files: one for each section.
      options.setDocumentSplitCriteria(DocumentSplitCriteria.SECTION_BREAK);
  
      // Assign a custom callback to the "DocumentPartSavingCallback" property to alter the document part saving logic.
      options.setDocumentPartSavingCallback(new SavedDocumentPartRename(outFileName, options.getDocumentSplitCriteria()));
  
      // If we convert a document that contains images into html, we will end up with one html file which links to several images.
      // Each image will be in the form of a file in the local file system.
      // There is also a callback that can customize the name and file system location of each image.
      options.setImageSavingCallback(new SavedImageRename(outFileName));
  
      doc.save(getArtifactsDir() + outFileName, options);
  }
  
  /// <summary>
  /// Sets custom filenames for output documents that the saving operation splits a document into.
  /// </summary>
  private static class SavedDocumentPartRename implements IDocumentPartSavingCallback {
      public SavedDocumentPartRename(String outFileName, int documentSplitCriteria) {
          mOutFileName = outFileName;
          mDocumentSplitCriteria = documentSplitCriteria;
      }
  
      public void documentPartSaving(DocumentPartSavingArgs args) throws Exception {
          // We can access the entire source document via the "Document" property.
          Assert.assertTrue(args.getDocument().getOriginalFileName().endsWith("Rendering.docx"));
  
          String partType = "";
  
          switch (mDocumentSplitCriteria) {
              case DocumentSplitCriteria.PAGE_BREAK:
                  partType = "Page";
                  break;
              case DocumentSplitCriteria.COLUMN_BREAK:
                  partType = "Column";
                  break;
              case DocumentSplitCriteria.SECTION_BREAK:
                  partType = "Section";
                  break;
              case DocumentSplitCriteria.HEADING_PARAGRAPH:
                  partType = "Paragraph from heading";
                  break;
          }
  
          String partFileName = MessageFormat.format("{0} part {1}, of type {2}.{3}", mOutFileName, ++mCount, partType, FilenameUtils.getExtension(args.getDocumentPartFileName()));
  
          // Below are two ways of specifying where Aspose.Words will save each part of the document.
          // 1 -  Set a filename for the output part file:
          args.setDocumentPartFileName(partFileName);
  
          // 2 -  Create a custom stream for the output part file:
          try (FileOutputStream outputStream = new FileOutputStream(getArtifactsDir() + partFileName)) {
              args.setDocumentPartStream(outputStream);
          }
  
          Assert.assertNotNull(args.getDocumentPartStream());
          Assert.assertFalse(args.getKeepDocumentPartStreamOpen());
      }
  
      private int mCount;
      private final String mOutFileName;
      private final int mDocumentSplitCriteria;
  }
  
  /// <summary>
  /// Sets custom filenames for image files that an HTML conversion creates.
  /// </summary>
  public static class SavedImageRename implements IImageSavingCallback {
      public SavedImageRename(String outFileName) {
          mOutFileName = outFileName;
      }
  
      public void imageSaving(ImageSavingArgs args) throws Exception {
          String imageFileName = MessageFormat.format("{0} shape {1}, of type {2}.{3}", mOutFileName, ++mCount, args.getCurrentShape().getShapeType(), FilenameUtils.getExtension(args.getImageFileName()));
  
          // Below are two ways of specifying where Aspose.Words will save each part of the document.
          // 1 -  Set a filename for the output image file:
          args.setImageFileName(imageFileName);
  
          // 2 -  Create a custom stream for the output image file:
          args.setImageStream(new FileOutputStream(getArtifactsDir() + imageFileName));
  
          Assert.assertNotNull(args.getImageStream());
          Assert.assertTrue(args.isImageAvailable());
          Assert.assertFalse(args.getKeepImageStreamOpen());
      }
  
      private int mCount;
      private final String mOutFileName;
  }

• getDocumentSplitCriteria/setDocumentSplitCriteria

  public int getDocumentSplitCriteria() / public void setDocumentSplitCriteria(int value)
  

  Specifies how the document should be split when saving to SaveFormat.HTML or SaveFormat.EPUB format. Default is DocumentSplitCriteria.NONE for HTML and DocumentSplitCriteria.HEADING_PARAGRAPH for EPUB. The value of the property is DocumentSplitCriteria integer constant.

  Normally you would want a document saved to HTML as a single file. But in some cases it is preferable to split the output into several smaller HTML pages. When saving to HTML format these pages will be output to individual files or streams. When saving to EPUB format they will be incorporated into corresponding packages.

  A document cannot be split when saving in the MHTML format.

  Example:

  Shows how to use a specific encoding when saving a document to .epub.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // Use a SaveOptions object to specify the encoding for a document that we will save.
  HtmlSaveOptions saveOptions = new HtmlSaveOptions();
  saveOptions.setSaveFormat(SaveFormat.EPUB);
  saveOptions.setEncoding(StandardCharsets.UTF_8);
  
  // By default, an output .epub document will have all of its contents in one HTML part.
  // A split criterion allows us to segment the document into several HTML parts.
  // We will set the criteria to split the document into heading paragraphs.
  // This is useful for readers who cannot read HTML files more significant than a specific size.
  saveOptions.setDocumentSplitCriteria(DocumentSplitCriteria.HEADING_PARAGRAPH);
  
  // Specify that we want to export document properties.
  saveOptions.setExportDocumentProperties(true);
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.Doc2EpubSaveOptions.epub", saveOptions);

  See Also:

  DocumentSplitHeadingLevel, DocumentPartSavingCallback

• getDocumentSplitHeadingLevel/setDocumentSplitHeadingLevel

  public int getDocumentSplitHeadingLevel() / public void setDocumentSplitHeadingLevel(int value)
  

  Specifies the maximum level of headings at which to split the document. Default value is 2.

  When DocumentSplitCriteria includes DocumentSplitCriteria.HEADING_PARAGRAPH and this property is set to a value from 1 to 9, the document will be split at paragraphs formatted using Heading 1, Heading 2 , Heading 3 etc. styles up to the specified heading level.

  By default, only Heading 1 and Heading 2 paragraphs cause the document to be split. Setting this property to zero will cause the document not to be split at heading paragraphs at all.

  Example:

  Shows how to split an output HTML document by headings into several parts.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Every paragraph that we format using a "Heading" style can serve as a heading.
  // Each heading may also have a heading level, determined by the number of its heading style.
  // The headings below are of levels 1-3.
  builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get("Heading 1"));
  builder.writeln("Heading #1");
  builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get("Heading 2"));
  builder.writeln("Heading #2");
  builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get("Heading 3"));
  builder.writeln("Heading #3");
  builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get("Heading 1"));
  builder.writeln("Heading #4");
  builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get("Heading 2"));
  builder.writeln("Heading #5");
  builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get("Heading 3"));
  builder.writeln("Heading #6");
  
  // Create a HtmlSaveOptions object and set the split criteria to "HeadingParagraph".
  // These criteria will split the document at paragraphs with "Heading" styles into several smaller documents,
  // and save each document in a separate HTML file in the local file system.
  // We will also set the maximum heading level, which splits the document to 2.
  // Saving the document will split it at headings of levels 1 and 2, but not at 3 to 9.
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setDocumentSplitCriteria(DocumentSplitCriteria.HEADING_PARAGRAPH);
      options.setDocumentSplitHeadingLevel(2);
  }
  
  // Our document has four headings of levels 1 - 2. One of those headings will not be
  // a split point since it is at the beginning of the document.
  // The saving operation will split our document at three places, into four smaller documents.
  doc.save(getArtifactsDir() + "HtmlSaveOptions.HeadingLevels.html", options);
  
  doc = new Document(getArtifactsDir() + "HtmlSaveOptions.HeadingLevels.html");
  
  Assert.assertEquals("Heading #1", doc.getText().trim());
  
  doc = new Document(getArtifactsDir() + "HtmlSaveOptions.HeadingLevels-01.html");
  
  Assert.assertEquals("Heading #2\r" +
          "Heading #3", doc.getText().trim());
  
  doc = new Document(getArtifactsDir() + "HtmlSaveOptions.HeadingLevels-02.html");
  
  Assert.assertEquals("Heading #4", doc.getText().trim());
  
  doc = new Document(getArtifactsDir() + "HtmlSaveOptions.HeadingLevels-03.html");
  
  Assert.assertEquals("Heading #5\rHeading #6", doc.getText().trim());

  See Also:

  DocumentSplitCriteria, DocumentPartSavingCallback

• getEncoding/setEncoding

  public java.nio.charset.Charset getEncoding() / public void setEncoding(java.nio.charset.Charset value)
  

  Specifies the encoding to use when exporting to HTML, MHTML or EPUB. Default value is 'UTF-8' Charset with BOM..

  Please note that BOM is added in the case of every Unicode charset (UTF-16, UTF-16BE, UTF-32, etc).

  Example:

  Shows how to use a specific encoding when saving a document to .epub.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // Use a SaveOptions object to specify the encoding for a document that we will save.
  HtmlSaveOptions saveOptions = new HtmlSaveOptions();
  saveOptions.setSaveFormat(SaveFormat.EPUB);
  saveOptions.setEncoding(StandardCharsets.UTF_8);
  
  // By default, an output .epub document will have all of its contents in one HTML part.
  // A split criterion allows us to segment the document into several HTML parts.
  // We will set the criteria to split the document into heading paragraphs.
  // This is useful for readers who cannot read HTML files more significant than a specific size.
  saveOptions.setDocumentSplitCriteria(DocumentSplitCriteria.HEADING_PARAGRAPH);
  
  // Specify that we want to export document properties.
  saveOptions.setExportDocumentProperties(true);
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.Doc2EpubSaveOptions.epub", saveOptions);

• getEpubNavigationMapLevel/setEpubNavigationMapLevel

  public int getEpubNavigationMapLevel() / public void setEpubNavigationMapLevel(int value)
  

  Specifies the maximum level of headings populated to the navigation map when exporting to IDPF EPUB format. Default value is 3.

  Navigation map in IDPF EPUB format allows user agents to provide easy way of navigation through the document structure. Usually navigation points correspond to headings in the document. To populate headings up to level N assign this value to EpubNavigationMapLevel.

  By default, three levels of headings are populated: paragraphs of styles Heading 1, Heading 2 and Heading 3. You can set this property to a value from 1 to 9 to request corresponding maximum level. Setting it to zero will reduce navigation map to only document root or roots of document parts.

  Example:

  Shows how to filter headings that appear in the navigation panel of a saved Epub document.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Every paragraph that we format using a "Heading" style can serve as a heading.
  // Each heading may also have a heading level, determined by the number of its heading style.
  // The headings below are of levels 1-3.
  builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get("Heading 1"));
  builder.writeln("Heading #1");
  builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get("Heading 2"));
  builder.writeln("Heading #2");
  builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get("Heading 3"));
  builder.writeln("Heading #3");
  builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get("Heading 1"));
  builder.writeln("Heading #4");
  builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get("Heading 2"));
  builder.writeln("Heading #5");
  builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get("Heading 3"));
  builder.writeln("Heading #6");
  
  // Epub readers typically create a table of contents for their documents.
  // Each paragraph with a "Heading" style in the document will create an entry in this table of contents.
  // We can use the "EpubNavigationMapLevel" property to set a maximum heading level. 
  // The Epub reader will not add headings with a level above the one we specify to the contents table.
  HtmlSaveOptions options = new HtmlSaveOptions(SaveFormat.EPUB);
  options.setEpubNavigationMapLevel(2);
  
  // Our document has six headings, two of which are above level 2.
  // The table of contents for this document will have four entries.
  doc.save(getArtifactsDir() + "HtmlSaveOptions.EpubHeadings.epub", options);

• getExportCidUrlsForMhtmlResources/setExportCidUrlsForMhtmlResources

  public boolean getExportCidUrlsForMhtmlResources() / public void setExportCidUrlsForMhtmlResources(boolean value)
  

  Specifies whether to use CID (Content-ID) URLs to reference resources (images, fonts, CSS) included in MHTML documents. Default value is false.

  This option affects only documents being saved to MHTML.

  By default, resources in MHTML documents are referenced by file name (for example, "image.png"), which are matched against "Content-Location" headers of MIME parts.

  This option enables an alternative method, where references to resource files are written as CID (Content-ID) URLs (for example, "cid:image.png") and are matched against "Content-ID" headers.

  In theory, there should be no difference between the two referencing methods and either of them should work fine in any browser or mail agent. In practice, however, some agents fail to fetch resources by file name. If your browser or mail agent refuses to load resources included in an MTHML document (doesn't show images or doesn't load CSS styles), try exporting the document with CID URLs.

  Example:

  Shows how to enable content IDs for output MHTML documents.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // Setting this flag will replace "Content-Location" tags
  // with "Content-ID" tags for each resource from the input document.
  HtmlSaveOptions options = new HtmlSaveOptions(SaveFormat.MHTML);
  {
      options.setExportCidUrlsForMhtmlResources(exportCidUrlsForMhtmlResources);
      options.setCssStyleSheetType(CssStyleSheetType.EXTERNAL);
      options.setExportFontResources(true);
      options.setPrettyFormat(true);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.ContentIdUrls.mht", options);
  
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.ContentIdUrls.mht"), StandardCharsets.UTF_8);
  
  if (exportCidUrlsForMhtmlResources) {
      Assert.assertTrue(outDocContents.contains("Content-ID: <document.html>"));
      Assert.assertTrue(outDocContents.contains("<link href=3D\"cid:styles.css\" type=3D\"text/css\" rel=3D\"stylesheet\" />"));
      Assert.assertTrue(outDocContents.contains("@font-face { font-family:'Arial Black'; font-weight:bold; src:url('cid:arib=\r\nlk.ttf') }"));
      Assert.assertTrue(outDocContents.contains("<img src=3D\"cid:image.003.jpeg\" width=3D\"350\" height=3D\"180\" alt=3D\"\" />"));
  } else {
      Assert.assertTrue(outDocContents.contains("Content-Location: document.html"));
      Assert.assertTrue(outDocContents.contains("<link href=3D\"styles.css\" type=3D\"text/css\" rel=3D\"stylesheet\" />"));
      Assert.assertTrue(outDocContents.contains("@font-face { font-family:'Arial Black'; font-weight:bold; src:url('ariblk.t=\r\ntf') }"));
      Assert.assertTrue(outDocContents.contains("<img src=3D\"image.003.jpeg\" width=3D\"350\" height=3D\"180\" alt=3D\"\" />"));
  }

• getExportDocumentProperties/setExportDocumentProperties

  public boolean getExportDocumentProperties() / public void setExportDocumentProperties(boolean value)
  

  Specifies whether to export built-in and custom document properties to HTML, MHTML or EPUB. Default value is false.

  Example:

  Shows how to use a specific encoding when saving a document to .epub.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // Use a SaveOptions object to specify the encoding for a document that we will save.
  HtmlSaveOptions saveOptions = new HtmlSaveOptions();
  saveOptions.setSaveFormat(SaveFormat.EPUB);
  saveOptions.setEncoding(StandardCharsets.UTF_8);
  
  // By default, an output .epub document will have all of its contents in one HTML part.
  // A split criterion allows us to segment the document into several HTML parts.
  // We will set the criteria to split the document into heading paragraphs.
  // This is useful for readers who cannot read HTML files more significant than a specific size.
  saveOptions.setDocumentSplitCriteria(DocumentSplitCriteria.HEADING_PARAGRAPH);
  
  // Specify that we want to export document properties.
  saveOptions.setExportDocumentProperties(true);
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.Doc2EpubSaveOptions.epub", saveOptions);

• getExportDropDownFormFieldAsText/setExportDropDownFormFieldAsText

  public boolean getExportDropDownFormFieldAsText() / public void setExportDropDownFormFieldAsText(boolean value)
  

  Controls how drop-down form fields are saved to HTML or MHTML. Default value is false.

  When set to true, exports drop-down form fields as normal text. When false, exports drop-down form fields as SELECT element in HTML.

  When exporting to EPUB, text drop-down form fields are always saved as text due to requirements of this format.

  Example:

  Shows how to get drop-down combo box form fields to blend in with paragraph text when saving to html.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Use a document builder to insert a combo box with the value "Two" selected.
  builder.insertComboBox("MyComboBox", new String[]{"One", "Two", "Three"}, 1);
  
  // The "ExportDropDownFormFieldAsText" flag of this SaveOptions object allows us to
  // control how saving the document to HTML treats drop-down combo boxes.
  // Setting it to "true" will convert each combo box into simple text
  // that displays the combo box's currently selected value, effectively freezing it.
  // Setting it to "false" will preserve the functionality of the combo box using <select> and <option> tags.
  HtmlSaveOptions options = new HtmlSaveOptions();
  options.setExportDropDownFormFieldAsText(exportDropDownFormFieldAsText);
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.DropDownFormField.html", options);
  
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.DropDownFormField.html"), StandardCharsets.UTF_8);
  
  if (exportDropDownFormFieldAsText)
      Assert.assertTrue(outDocContents.contains(
              "<span>Two</span>"));
  else
      Assert.assertTrue(outDocContents.contains(
              "<select name=\"MyComboBox\">" +
                      "<option>One</option>" +
                      "<option selected=\"selected\">Two</option>" +
                      "<option>Three</option>" +
                      "</select>"));

• getExportFontResources/setExportFontResources

  public boolean getExportFontResources() / public void setExportFontResources(boolean value)
  

  Specifies whether font resources should be exported to HTML, MHTML or EPUB. Default is false.

  Exporting font resources allows for consistent document rendering independent of the fonts available in a given user's environment.

  If ExportFontResources is set to true, main HTML document will refer to every font via the CSS 3 @font-face at-rule and fonts will be output as separate files. When exporting to IDPF EPUB or MHTML formats, fonts will be embedded into the corresponding package along with other subsidiary files.

  If ExportFontsAsBase64 is set to true, fonts will not be saved to separate files. Instead, they will be embedded into @font-face at-rules in Base64 encoding.

  Important! When exporting font resources, font licensing issues should be considered. Authors who want to use specific fonts via a downloadable font mechanism must always carefully verify that their intended use is within the scope of the font license. Many commercial fonts presently do not allow web downloading of their fonts in any form. License agreements that cover some fonts specifically note that usage via @font-face rules in CSS style sheets is not allowed. Font subsetting can also violate license terms.

  Example:

  Shows how to define custom logic for exporting fonts when saving to HTML.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
      // Configure a SaveOptions object to export fonts to separate files.
      // Set a callback that will handle font saving in a custom manner.
      HtmlSaveOptions options = new HtmlSaveOptions();
      {
          options.setExportFontResources(true);
          options.setFontSavingCallback(new HandleFontSaving());
      }
  
      // The callback will export .ttf files and save them alongside the output document.
      doc.save(getArtifactsDir() + "HtmlSaveOptions.SaveExportedFonts.html", options);
  
      File[] fontFileNames = new File(getArtifactsDir()).listFiles((d, name) -> name.endsWith(".ttf"));
  
      for (File fontFilename : fontFileNames) {
          System.out.println(fontFilename.getName());
      }
  
  /// <summary>
  /// Prints information about exported fonts and saves them in the same local system folder as their output .html.
  /// </summary>
  public static class HandleFontSaving implements IFontSavingCallback {
      public void fontSaving(FontSavingArgs args) throws Exception {
          System.out.println(MessageFormat.format("Font:\t{0}", args.getFontFamilyName()));
          if (args.getBold()) System.out.print(", bold");
          if (args.getItalic()) System.out.print(", italic");
          System.out.println(MessageFormat.format("\nSource:\t{0}, {1} bytes\n", args.getOriginalFileName(), args.getOriginalFileSize()));
  
          // We can also access the source document from here.
          Assert.assertTrue(args.getDocument().getOriginalFileName().endsWith("Rendering.docx"));
  
          Assert.assertTrue(args.isExportNeeded());
          Assert.assertTrue(args.isSubsettingNeeded());
  
          String[] splittedFileName = args.getOriginalFileName().split("\\\\");
          String fileName = splittedFileName[splittedFileName.length - 1];
  
          // There are two ways of saving an exported font.
          // 1 -  Save it to a local file system location:
          args.setFontFileName(fileName);
  
          // 2 -  Save it to a stream:
          args.setFontStream(new FileOutputStream(fileName));
          Assert.assertFalse(args.getKeepFontStreamOpen());
      }
  }

  See Also:

  FontResourcesSubsettingSizeThreshold

• getExportFontsAsBase64/setExportFontsAsBase64

  public boolean getExportFontsAsBase64() / public void setExportFontsAsBase64(boolean value)
  

  Specifies whether fonts resources should be embedded to HTML in Base64 encoding. Default is false.

  By default, fonts are written to separate files. If this option is set to true, fonts will be embedded into the document's CSS in Base64 encoding.

  Example:

  Shows how to embed fonts inside a saved HTML document.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setExportFontsAsBase64(true);
      options.setCssStyleSheetType(CssStyleSheetType.EMBEDDED);
      options.setPrettyFormat(true);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.ExportFontsAsBase64.html", options);

  Example:

  Shows how to save a .html document with images embedded inside it.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setExportImagesAsBase64(exportImagesAsBase64);
      options.setPrettyFormat(true);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.ExportImagesAsBase64.html", options);
  
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.ExportImagesAsBase64.html"), StandardCharsets.UTF_8);
  
  Assert.assertTrue(exportImagesAsBase64
          ? outDocContents.contains("<img src=\"data:image/png;base64")
          : outDocContents.contains("<img src=\"HtmlSaveOptions.ExportImagesAsBase64.001.png\""));

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

• getExportHeadersFootersMode/setExportHeadersFootersMode

  public int getExportHeadersFootersMode() / public void setExportHeadersFootersMode(int value)
  

  Specifies how headers and footers are output to HTML, MHTML or EPUB. Default value is ExportHeadersFootersMode.PER_SECTION for HTML/MHTML and ExportHeadersFootersMode.NONE for EPUB. The value of the property is ExportHeadersFootersMode integer constant.

  It is hard to meaningfully output headers and footers to HTML because HTML is not paginated.

  When this property is ExportHeadersFootersMode.PER_SECTION, Aspose.Words exports only primary headers and footers at the beginning and the end of each section.

  When it is ExportHeadersFootersMode.FIRST_SECTION_HEADER_LAST_SECTION_FOOTER only first primary header and the last primary footer (including linked to previous) are exported.

  You can disable export of headers and footers altogether by setting this property to ExportHeadersFootersMode.NONE.

  Example:

  Shows how to omit headers/footers when saving a document to HTML.

  Document doc = new Document(getMyDir() + "Header and footer types.docx");
  
  // This document contains headers and footers. We can access them via the "HeadersFooters" collection.
  Assert.assertEquals("First header", doc.getFirstSection().getHeadersFooters().getByHeaderFooterType(HeaderFooterType.HEADER_FIRST).getText().trim());
  
  // Formats such as .html do not split the document into pages, so headers/footers will not function the same way
  // they would when we open the document as a .docx using Microsoft Word.
  // If we convert a document with headers/footers to html, the conversion will assimilate the headers/footers into body text.
  // We can use a SaveOptions object to omit headers/footers while converting to html.
  HtmlSaveOptions saveOptions =
          new HtmlSaveOptions(SaveFormat.HTML);
  {
      saveOptions.setExportHeadersFootersMode(ExportHeadersFootersMode.NONE);
  }
  
  doc.save(getArtifactsDir() + "HeaderFooter.ExportMode.html", saveOptions);
  
  // Open our saved document and verify that it does not contain the header's text.
  doc = new Document(getArtifactsDir() + "HeaderFooter.ExportMode.html");
  
  Assert.assertFalse(doc.getRange().getText().contains("First header"));

• getExportImagesAsBase64/setExportImagesAsBase64

  public boolean getExportImagesAsBase64() / public void setExportImagesAsBase64(boolean value)
  

  Specifies whether images are saved in Base64 format to the output HTML, MHTML or EPUB. Default is false.

  When this property is set to true images data are exported directly into the img elements and separate files are not created.

  Example:

  Shows how to embed fonts inside a saved HTML document.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setExportFontsAsBase64(true);
      options.setCssStyleSheetType(CssStyleSheetType.EMBEDDED);
      options.setPrettyFormat(true);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.ExportFontsAsBase64.html", options);

  Example:

  Shows how to save a .html document with images embedded inside it.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setExportImagesAsBase64(exportImagesAsBase64);
      options.setPrettyFormat(true);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.ExportImagesAsBase64.html", options);
  
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.ExportImagesAsBase64.html"), StandardCharsets.UTF_8);
  
  Assert.assertTrue(exportImagesAsBase64
          ? outDocContents.contains("<img src=\"data:image/png;base64")
          : outDocContents.contains("<img src=\"HtmlSaveOptions.ExportImagesAsBase64.001.png\""));

• getExportLanguageInformation/setExportLanguageInformation

  public boolean getExportLanguageInformation() / public void setExportLanguageInformation(boolean value)
  

  Specifies whether language information is exported to HTML, MHTML or EPUB. Default is false.

  When this property is set to true Aspose.Words outputs lang HTML attribute on the document elements that specify language. This can be needed to preserve language related semantics.

  Example:

  Shows how to preserve language information when saving to .html.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Use the builder to write text while formatting it in different locales.
  builder.getFont().setLocaleId(1033);
  builder.writeln("Hello world!");
  
  builder.getFont().setLocaleId(2057);
  builder.writeln("Hello again!");
  
  builder.getFont().setLocaleId(1049);
  builder.write("Привет, мир!");
  
  // When saving the document to HTML, we can pass a SaveOptions object
  // to either preserve or discard each formatted text's locale.
  // If we set the "ExportLanguageInformation" flag to "true",
  // the output HTML document will contain the locales in "lang" attributes of <span> tags.
  // If we set the "ExportLanguageInformation" flag to "false',
  // the text in the output HTML document will not contain any locale information.
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setExportLanguageInformation(exportLanguageInformation);
      options.setPrettyFormat(true);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.ExportLanguageInformation.html", options);
  
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.ExportLanguageInformation.html"), StandardCharsets.UTF_8);
  
  if (exportLanguageInformation) {
      Assert.assertTrue(outDocContents.contains("<span>Hello world!</span>"));
      Assert.assertTrue(outDocContents.contains("<span lang=\"en-GB\">Hello again!</span>"));
      Assert.assertTrue(outDocContents.contains("<span lang=\"ru-RU\">Привет, мир!</span>"));
  } else {
      Assert.assertTrue(outDocContents.contains("<span>Hello world!</span>"));
      Assert.assertTrue(outDocContents.contains("<span>Hello again!</span>"));
      Assert.assertTrue(outDocContents.contains("<span>Привет, мир!</span>"));
  }

• getExportListLabels/setExportListLabels

  public int getExportListLabels() / public void setExportListLabels(int value)
  

  Controls how list labels are output to HTML, MHTML or EPUB. Default value is ExportListLabels.AUTO. The value of the property is ExportListLabels integer constant.

  Example:

  Shows how to configure list exporting to HTML.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  List list = doc.getLists().add(ListTemplate.NUMBER_DEFAULT);
  builder.getListFormat().setList(list);
  
  builder.writeln("Default numbered list item 1.");
  builder.writeln("Default numbered list item 2.");
  builder.getListFormat().listIndent();
  builder.writeln("Default numbered list item 3.");
  builder.getListFormat().removeNumbers();
  
  list = doc.getLists().add(ListTemplate.OUTLINE_HEADINGS_LEGAL);
  builder.getListFormat().setList(list);
  
  builder.writeln("Outline legal heading list item 1.");
  builder.writeln("Outline legal heading list item 2.");
  builder.getListFormat().listIndent();
  builder.writeln("Outline legal heading list item 3.");
  builder.getListFormat().listIndent();
  builder.writeln("Outline legal heading list item 4.");
  builder.getListFormat().listIndent();
  builder.writeln("Outline legal heading list item 5.");
  builder.getListFormat().removeNumbers();
  
  // When saving the document to HTML, we can pass a SaveOptions object
  // to decide which HTML elements the document will use to represent lists.
  // Setting the "ExportListLabels" property to "ExportListLabels.AsInlineText"
  // will create lists by formatting spans.
  // Setting the "ExportListLabels" property to "ExportListLabels.Auto" will use the <p> tag
  // to build lists in cases when using the <ol> and <li> tags may cause loss of formatting.
  // Setting the "ExportListLabels" property to "ExportListLabels.ByHtmlTags"
  // will use <ol> and <li> tags to build all lists.
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setExportListLabels(exportListLabels);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.List.html", options);
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.List.html"), StandardCharsets.UTF_8);
  
  switch (exportListLabels) {
      case ExportListLabels.AS_INLINE_TEXT:
          Assert.assertTrue(outDocContents.contains(
                  "<p style=\"margin-top:0pt; margin-left:72pt; margin-bottom:0pt; text-indent:-18pt; -aw-import:list-item; -aw-list-level-number:1; -aw-list-number-format:'%1.'; -aw-list-number-styles:'lowerLetter'; -aw-list-number-values:'1'; -aw-list-padding-sml:9.67pt\">" +
                          "<span style=\"-aw-import:ignore\">" +
                          "<span>a.</span>" +
                          "<span style=\"width:9.67pt; font:7pt 'Times New Roman'; display:inline-block; -aw-import:spaces\">&#xa0;&#xa0;&#xa0;&#xa0;&#xa0;&#xa0; </span>" +
                          "</span>" +
                          "<span>Default numbered list item 3.</span>" +
                          "</p>"));
  
          Assert.assertTrue(outDocContents.contains(
                  "<p style=\"margin-top:0pt; margin-left:43.2pt; margin-bottom:0pt; text-indent:-43.2pt; -aw-import:list-item; -aw-list-level-number:3; -aw-list-number-format:'%0.%1.%2.%3'; -aw-list-number-styles:'decimal decimal decimal decimal'; -aw-list-number-values:'2 1 1 1'; -aw-list-padding-sml:10.2pt\">" +
                          "<span style=\"-aw-import:ignore\">" +
                          "<span>2.1.1.1</span>" +
                          "<span style=\"width:10.2pt; font:7pt 'Times New Roman'; display:inline-block; -aw-import:spaces\">&#xa0;&#xa0;&#xa0;&#xa0;&#xa0;&#xa0; </span>" +
                          "</span>" +
                          "<span>Outline legal heading list item 5.</span>" +
                          "</p>"));
          break;
      case ExportListLabels.AUTO:
          Assert.assertTrue(outDocContents.contains(
                  "<ol type=\"a\" style=\"margin-right:0pt; margin-left:0pt; padding-left:0pt\">" +
                          "<li style=\"margin-left:31.33pt; padding-left:4.67pt\">" +
                          "<span>Default numbered list item 3.</span>" +
                          "</li>" +
                          "</ol>"));
  
          Assert.assertTrue(outDocContents.contains(
                  "<p style=\"margin-top:0pt; margin-left:43.2pt; margin-bottom:0pt; text-indent:-43.2pt; -aw-import:list-item; -aw-list-level-number:3; " +
                          "-aw-list-number-format:'%0.%1.%2.%3'; -aw-list-number-styles:'decimal decimal decimal decimal'; " +
                          "-aw-list-number-values:'2 1 1 1'; -aw-list-padding-sml:10.2pt\">" +
                          "<span style=\"-aw-import:ignore\">" +
                          "<span>2.1.1.1</span>" +
                          "<span style=\"width:10.2pt; font:7pt 'Times New Roman'; display:inline-block; -aw-import:spaces\">&#xa0;&#xa0;&#xa0;&#xa0;&#xa0;&#xa0; </span>" +
                          "</span>" +
                          "<span>Outline legal heading list item 5.</span>" +
                          "</p>"));
          break;
      case ExportListLabels.BY_HTML_TAGS:
          Assert.assertTrue(outDocContents.contains(
                  "<ol type=\"a\" style=\"margin-right:0pt; margin-left:0pt; padding-left:0pt\">" +
                          "<li style=\"margin-left:31.33pt; padding-left:4.67pt\">" +
                          "<span>Default numbered list item 3.</span>" +
                          "</li>" +
                          "</ol>"));
  
          Assert.assertTrue(outDocContents.contains(
                  "<ol type=\"1\" class=\"awlist3\" style=\"margin-right:0pt; margin-left:0pt; padding-left:0pt\">" +
                          "<li style=\"margin-left:7.2pt; text-indent:-43.2pt; -aw-list-padding-sml:10.2pt\">" +
                          "<span style=\"width:10.2pt; font:7pt 'Times New Roman'; display:inline-block; -aw-import:ignore\">&#xa0;&#xa0;&#xa0;&#xa0;&#xa0;&#xa0; </span>" +
                          "<span>Outline legal heading list item 5.</span>" +
                          "</li>" +
                          "</ol>"));
          break;
  }

• getExportOriginalUrlForLinkedImages/setExportOriginalUrlForLinkedImages

  public boolean getExportOriginalUrlForLinkedImages() / public void setExportOriginalUrlForLinkedImages(boolean value)
  

  Specifies whether original URL should be used as the URL of the linked images. Default value is false.

  If value is set to trueImageData.SourceFullName value is used as the URL of linked images and linked images are not loaded into document's folder or ImagesFolder.

  If value is set to false linked images are loaded into document's folder or ImagesFolder and URL of each linked image is constructed depending on document's folder, ImagesFolder and ImagesFolderAlias properties.

  Example:

  Shows how to set folders and folder aliases for externally saved resources that Aspose.Words will create when saving a document to HTML.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setCssStyleSheetType(CssStyleSheetType.EXTERNAL);
      options.setExportFontResources(true);
      options.setImageResolution(72);
      options.setFontResourcesSubsettingSizeThreshold(0);
      options.setFontsFolder(getArtifactsDir() + "Fonts");
      options.setImagesFolder(getArtifactsDir() + "Images");
      options.setResourceFolder(getArtifactsDir() + "Resources");
      options.setFontsFolderAlias("http://example.com/fonts");
      options.setImagesFolderAlias("http://example.com/images");
      options.setResourceFolderAlias("http://example.com/resources");
      options.setExportOriginalUrlForLinkedImages(true);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.FolderAlias.html", options);

• getExportPageMargins/setExportPageMargins

  public boolean getExportPageMargins() / public void setExportPageMargins(boolean value)
  

  Specifies whether page margins is exported to HTML, MHTML or EPUB. Default is false.

  Aspose.Words does not show area of page margins by default. If any elements are completely or partially clipped by the document edge the displayed area can be extended with this option.

  Example:

  Shows how to show out-of-bounds objects in output HTML documents.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Use a builder to insert a shape with no wrapping.
  Shape shape = builder.insertShape(ShapeType.CUBE, 200.0, 200.0);
  
  shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
  shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
  shape.setWrapType(WrapType.NONE);
  
  // Negative shape position values may place the shape outside of page boundaries.
  // If we export this to HTML, the shape will appear truncated.
  shape.setLeft(-150);
  
  // When saving the document to HTML, we can pass a SaveOptions object
  // to decide whether to adjust the page to display out-of-bounds objects fully.
  // If we set the "ExportPageMargins" flag to "true", the shape will be fully visible in the output HTML.
  // If we set the "ExportPageMargins" flag to "false",
  // our document will display the shape truncated as we would see it in Microsoft Word.
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setExportPageMargins(exportPageMargins);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.ExportPageMargins.html", options);
  
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.ExportPageMargins.html"), StandardCharsets.UTF_8);
  
  if (exportPageMargins) {
      Assert.assertTrue(outDocContents.contains("<style type=\"text/css\">div.Section1 { margin:72pt }</style>"));
      Assert.assertTrue(outDocContents.contains("<div class=\"Section1\"><p style=\"margin-top:0pt; margin-left:151pt; margin-bottom:0pt\">"));
  } else {
      Assert.assertFalse(outDocContents.contains("style type=\"text/css\">"));
      Assert.assertTrue(outDocContents.contains("<div><p style=\"margin-top:0pt; margin-left:223pt; margin-bottom:0pt\">"));
  }

• getExportPageSetup/setExportPageSetup

  public boolean getExportPageSetup() / public void setExportPageSetup(boolean value)
  

  Specifies whether page setup is exported to HTML, MHTML or EPUB. Default is false.

  Each Section in Aspose.Words document model provides page setup information via PageSetup class. When you export a document to HTML format you might need to keep this information for further usage. In particular, page setup might be important for rendering to paged media (printing) or subsequent conversion to the native Microsoft Word file formats (DOCX, DOC, RTF, WML).

  In most cases HTML is intended for viewing in browsers where pagination is not performed. So this feature is inactive by default.

  Example:

  Shows how decide whether to preserve section structure/page setup information when saving to HTML.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.write("Section 1");
  builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
  builder.write("Section 2");
  
  PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
  pageSetup.setTopMargin(36.0);
  pageSetup.setBottomMargin(36.0);
  pageSetup.setPaperSize(PaperSize.A5);
  
  // When saving the document to HTML, we can pass a SaveOptions object
  // to decide whether to preserve or discard page setup settings.
  // If we set the "ExportPageSetup" flag to "true", the output HTML document will contain our page setup configuration.
  // If we set the "ExportPageSetup" flag to "false", the save operation will discard our page setup settings
  // for the first section, and both sections will look identical.
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setExportPageSetup(exportPageSetup);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.ExportPageSetup.html", options);
  
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.ExportPageSetup.html"), StandardCharsets.UTF_8);
  
  if (exportPageSetup) {
      Assert.assertTrue(outDocContents.contains(
              "<style type=\"text/css\">" +
                      "@page Section1 { size:419.55pt 595.3pt; margin:36pt 72pt }" +
                      "@page Section2 { size:612pt 792pt; margin:72pt }" +
                      "div.Section1 { page:Section1 }div.Section2 { page:Section2 }" +
                      "</style>"));
  
      Assert.assertTrue(outDocContents.contains(
              "<div class=\"Section1\">" +
                      "<p style=\"margin-top:0pt; margin-bottom:0pt\">" +
                      "<span>Section 1</span>" +
                      "</p>" +
                      "</div>"));
  } else {
      Assert.assertFalse(outDocContents.contains("style type=\"text/css\">"));
  
      Assert.assertTrue(outDocContents.contains(
              "<div>" +
                      "<p style=\"margin-top:0pt; margin-bottom:0pt\">" +
                      "<span>Section 1</span>" +
                      "</p>" +
                      "</div>"));
  }

• getExportRelativeFontSize/setExportRelativeFontSize

  public boolean getExportRelativeFontSize() / public void setExportRelativeFontSize(boolean value)
  

  Specifies whether font sizes should be output in relative units when saving to HTML, MHTML or EPUB. Default is false.

  In many existing documents (HTML, IDPF EPUB) font sizes are specified in relative units. This allows applications to adjust text size when viewing/processing documents. For instance, Microsoft Internet Explorer has "View->Text Size" submenu, Adobe Digital Editions has two buttons: Increase/Decrease Text Size. If you expect this functionality to work then set ExportRelativeFontSize property to true.

  Aspose Words document model contains and operates only with absolute font size units. Relative units need additional logic to be recalculated from some initial (standard) size. Font size of Normal document style is taken as standard. For instance, if Normal has 12pt font and some text is 18pt then it will be output as 1.5em. to the HTML.

  When this option is enabled, document elements other than text will still have absolute sizes. Also some text-related attributes might be expressed absolutely. In particular, line spacing specified with "exactly" rule might produce unwanted results when scaling text. So the source documents should be properly designed and tested when exporting with ExportRelativeFontSize set to true.

  Example:

  Shows how to use relative font sizes when saving to .html.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.writeln("Default font size, ");
  builder.getFont().setSize(24.0);
  builder.writeln("2x default font size,");
  builder.getFont().setSize(96.0);
  builder.write("8x default font size");
  
  // When we save the document to HTML, we can pass a SaveOptions object
  // to determine whether to use relative or absolute font sizes.
  // Set the "ExportRelativeFontSize" flag to "true" to declare font sizes
  // using the "em" measurement unit, which is a factor that multiplies the current font size. 
  // Set the "ExportRelativeFontSize" flag to "false" to declare font sizes
  // using the "pt" measurement unit, which is the font's absolute size in points.
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setExportRelativeFontSize(exportRelativeFontSize);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.RelativeFontSize.html", options);
  
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.RelativeFontSize.html"), StandardCharsets.UTF_8);
  
  if (exportRelativeFontSize) {
      Assert.assertTrue(outDocContents.contains(
              "<body style=\"font-family:'Times New Roman'\">" +
                      "<div>" +
                      "<p style=\"margin-top:0pt; margin-bottom:0pt\">" +
                      "<span>Default font size, </span>" +
                      "</p>" +
                      "<p style=\"margin-top:0pt; margin-bottom:0pt; font-size:2em\">" +
                      "<span>2x default font size,</span>" +
                      "</p>" +
                      "<p style=\"margin-top:0pt; margin-bottom:0pt; font-size:8em\">" +
                      "<span>8x default font size</span>" +
                      "</p>" +
                      "</div>" +
                      "</body>"));
  } else {
      Assert.assertTrue(outDocContents.contains(
              "<body style=\"font-family:'Times New Roman'; font-size:12pt\">" +
                      "<div>" +
                      "<p style=\"margin-top:0pt; margin-bottom:0pt\">" +
                      "<span>Default font size, </span>" +
                      "</p>" +
                      "<p style=\"margin-top:0pt; margin-bottom:0pt; font-size:24pt\">" +
                      "<span>2x default font size,</span>" +
                      "</p>" +
                      "<p style=\"margin-top:0pt; margin-bottom:0pt; font-size:96pt\">" +
                      "<span>8x default font size</span>" +
                      "</p>" +
                      "</div>" +
                      "</body>"));
  }

• getExportRoundtripInformation/setExportRoundtripInformation

  public boolean getExportRoundtripInformation() / public void setExportRoundtripInformation(boolean value)
  

  Specifies whether to write the roundtrip information when saving to HTML, MHTML or EPUB. Default value is true for HTML and false for MHTML and EPUB.

  Saving of the roundtrip information allows to restore document properties such as tab stops, comments, headers and footers during the HTML documents loading back into a Document object.

  When true, the roundtrip information is exported as -aw-* CSS properties of the corresponding HTML elements.

  When false, causes no roundtrip information to be output into produced files.

  Example:

  Shows how to preserve hidden elements when converting to .html.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // When converting a document to .html, some elements such as hidden bookmarks, original shape positions,
  // or footnotes will be either removed or converted to plain text and effectively be lost.
  // Saving with a HtmlSaveOptions object with ExportRoundtripInformation set to true will preserve these elements.
  
  // When we save the document to HTML, we can pass a SaveOptions object to determine
  // how the saving operation will export document elements that HTML does not support or use,
  // such as hidden bookmarks and original shape positions.
  // If we set the "ExportRoundtripInformation" flag to "true", the save operation will preserve these elements.
  // If we set the "ExportRoundTripInformation" flag to "false", the save operation will discard these elements.
  // We will want to preserve such elements if we intend to load the saved HTML using Aspose.Words,
  // as they could be of use once again.
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setExportRoundtripInformation(exportRoundtripInformation);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.RoundTripInformation.html", options);
  
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.RoundTripInformation.html"), StandardCharsets.UTF_8);
  doc = new Document(getArtifactsDir() + "HtmlSaveOptions.RoundTripInformation.html");
  
  if (exportRoundtripInformation) {
      Assert.assertTrue(outDocContents.contains("<div style=\"-aw-headerfooter-type:header-primary; clear:both\">"));
      Assert.assertTrue(outDocContents.contains("<span style=\"-aw-import:ignore\">&#xa0;</span>"));
  
      Assert.assertTrue(outDocContents.contains(
              "td colspan=\"2\" style=\"width:210.6pt; border-style:solid; border-width:0.75pt 6pt 0.75pt 0.75pt; " +
                      "padding-right:2.4pt; padding-left:5.03pt; vertical-align:top; " +
                      "-aw-border-bottom:0.5pt single; -aw-border-left:0.5pt single; -aw-border-top:0.5pt single\">"));
  
      Assert.assertTrue(outDocContents.contains(
              "<li style=\"margin-left:30.2pt; padding-left:5.8pt; -aw-font-family:'Courier New'; -aw-font-weight:normal; -aw-number-format:'o'\">"));
  
      Assert.assertTrue(outDocContents.contains(
              "<img src=\"HtmlSaveOptions.RoundTripInformation.003.jpeg\" width=\"350\" height=\"180\" alt=\"\" " +
                      "style=\"-aw-left-pos:0pt; -aw-rel-hpos:column; -aw-rel-vpos:paragraph; -aw-top-pos:0pt; -aw-wrap-type:inline\" />"));
  
      Assert.assertTrue(outDocContents.contains(
              "<span>Page number </span>" +
                      "<span style=\"-aw-field-start:true\"></span>" +
                      "<span style=\"-aw-field-code:' PAGE   \\\\* MERGEFORMAT '\"></span>" +
                      "<span style=\"-aw-field-separator:true\"></span>" +
                      "<span>1</span>" +
                      "<span style=\"-aw-field-end:true\"></span>"));
  
      Assert.assertEquals(1, IterableUtils.countMatches(doc.getRange().getFields(), f -> f.getType() == FieldType.FIELD_PAGE));
  } else {
      Assert.assertTrue(outDocContents.contains("<div style=\"clear:both\">"));
      Assert.assertTrue(outDocContents.contains("<span>&#xa0;</span>"));
  
      Assert.assertTrue(outDocContents.contains(
              "<td colspan=\"2\" style=\"width:210.6pt; border-style:solid; border-width:0.75pt 6pt 0.75pt 0.75pt; " +
                      "padding-right:2.4pt; padding-left:5.03pt; vertical-align:top\">"));
  
      Assert.assertTrue(outDocContents.contains(
              "<li style=\"margin-left:30.2pt; padding-left:5.8pt\">"));
  
      Assert.assertTrue(outDocContents.contains(
              "<img src=\"HtmlSaveOptions.RoundTripInformation.003.jpeg\" width=\"350\" height=\"180\" alt=\"\" />"));
  
      Assert.assertTrue(outDocContents.contains(
              "<span>Page number 1</span>"));
  
      Assert.assertEquals(0, IterableUtils.countMatches(doc.getRange().getFields(), f -> f.getType() == FieldType.FIELD_PAGE));
  }

• getExportShapesAsSvg/setExportShapesAsSvg

  public boolean getExportShapesAsSvg() / public void setExportShapesAsSvg(boolean value)
  

  Controls whether Shape nodes are converted to SVG images when saving to HTML, MHTML or EPUB. Default value is false.

  If this option is set to true, Shape nodes are exported as <svg> elements. Otherwise, they are rendered to bitmaps and are exported as <img> elements.

  Note that this options also affects text boxes, because they are represented by Shape nodes. As a result, if this option is set to true, it overrides the ExportTextBoxAsSvg property value and causes text boxes to be converted to SVG.

  Example:

  Shows how to export text boxes as scalable vector graphics.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  Shape textBox = builder.insertShape(ShapeType.TEXT_BOX, 100.0, 60.0);
  builder.moveTo(textBox.getFirstParagraph());
  builder.write("My text box");
  
  // When we save the document to HTML, we can pass a SaveOptions object
  // to determine how the saving operation will export text box shapes.
  // If we set the "ExportTextBoxAsSvg" flag to "true",
  // the save operation will convert shapes with text into SVG objects.
  // If we set the "ExportTextBoxAsSvg" flag to "false",
  // the save operation will convert shapes with text into images.
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setExportShapesAsSvg(exportShapesAsSvg);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.ExportTextBox.html", options);
  
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.ExportTextBox.html"), StandardCharsets.UTF_8);
  
  if (exportShapesAsSvg) {
      Assert.assertTrue(outDocContents.contains(
              "<span style=\"-aw-left-pos:0pt; -aw-rel-hpos:column; -aw-rel-vpos:paragraph; -aw-top-pos:0pt; -aw-wrap-type:inline\">" +
                      "<svg xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"1.1\" width=\"133\" height=\"80\">"));
  } else {
      Assert.assertTrue(outDocContents.contains(
              "<p style=\"margin-top:0pt; margin-bottom:0pt\">" +
                      "<img src=\"HtmlSaveOptions.ExportTextBox.001.png\" width=\"136\" height=\"83\" alt=\"\" " +
                      "style=\"-aw-left-pos:0pt; -aw-rel-hpos:column; -aw-rel-vpos:paragraph; -aw-top-pos:0pt; -aw-wrap-type:inline\" />" +
                      "</p>"));
  }

• getExportTextBoxAsSvg/setExportTextBoxAsSvg

  @Deprecated
  public boolean getExportTextBoxAsSvg() / public void setExportTextBoxAsSvg(boolean value)
  

  Deprecated. Controls whether Shape nodes that represent text boxes are converted to SVG images when saving to HTML, MHTML or EPUB. Default value is false.

  If this option is set to true, text boxes are exported as <svg> elements. Otherwise, they are rendered to bitmaps and are exported as <img> elements.

  Note that if ExportShapesAsSvg is set to true, text boxes will be exported as SVG even if this property is set to false.

• getExportTextInputFormFieldAsText/setExportTextInputFormFieldAsText

  public boolean getExportTextInputFormFieldAsText() / public void setExportTextInputFormFieldAsText(boolean value)
  

  Controls how text input form fields are saved to HTML or MHTML. Default value is false.

  When set to true, exports text input form fields as normal text. When false, exports Word text input form fields as INPUT elements in HTML.

  When exporting to EPUB, text input form fields are always saved as text due to requirements of this format.

  Example:

  Shows how to specify the folder for storing linked images after saving to .html.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  File imagesDir = new File(getArtifactsDir() + "SaveHtmlWithOptions");
  
  if (imagesDir.exists())
      imagesDir.delete();
  
  imagesDir.mkdir();
  
  // Set an option to export form fields as plain text instead of HTML input elements.
  HtmlSaveOptions options = new HtmlSaveOptions(SaveFormat.HTML);
  options.setExportTextInputFormFieldAsText(true);
  options.setImagesFolder(imagesDir.getPath());
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.SaveHtmlWithOptions.html", options);

• getExportTocPageNumbers/setExportTocPageNumbers

  public boolean getExportTocPageNumbers() / public void setExportTocPageNumbers(boolean value)
  

  Specifies whether to write page numbers to table of contents when saving HTML, MHTML and EPUB. Default value is false.

  Example:

  Shows how to display page numbers when saving a document with a table of contents to .html.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert a table of contents, and then populate the document with paragraphs formatted using a "Heading"
  // style that the table of contents will pick up as entries. Each entry will display the heading paragraph on the left,
  // and the page number that contains the heading on the right.
  FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true);
  
  builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get("Heading 1"));
  builder.insertBreak(BreakType.PAGE_BREAK);
  builder.writeln("Entry 1");
  builder.writeln("Entry 2");
  builder.insertBreak(BreakType.PAGE_BREAK);
  builder.writeln("Entry 3");
  builder.insertBreak(BreakType.PAGE_BREAK);
  builder.writeln("Entry 4");
  fieldToc.updatePageNumbers();
  doc.updateFields();
  
  // HTML documents do not have pages. If we save this document to HTML,
  // the page numbers that our TOC displays will have no meaning.
  // When we save the document to HTML, we can pass a SaveOptions object to omit these page numbers from the TOC.
  // If we set the "ExportTocPageNumbers" flag to "true",
  // each TOC entry will display the heading, separator, and page number, preserving its appearance in Microsoft Word.
  // If we set the "ExportTocPageNumbers" flag to "false",
  // the save operation will omit both the separator and page number and leave the heading for each entry intact.
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setExportTocPageNumbers(exportTocPageNumbers);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.ExportTocPageNumbers.html", options);
  
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.ExportTocPageNumbers.html"), StandardCharsets.UTF_8);
  
  if (exportTocPageNumbers) {
      Assert.assertTrue(outDocContents.contains(
              "<p style=\"margin-top:0pt; margin-bottom:0pt\">" +
                      "<span>Entry 1</span>" +
                      "<span style=\"width:425.84pt; font-family:'Lucida Console'; font-size:10pt; display:inline-block; -aw-font-family:'Times New Roman'; " +
                      "-aw-tabstop-align:right; -aw-tabstop-leader:dots; -aw-tabstop-pos:467.5pt\">......................................................................</span>" +
                      "<span>2</span>" +
                      "</p>"));
  } else {
      Assert.assertTrue(outDocContents.contains(
              "<p style=\"margin-top:0pt; margin-bottom:0pt\">" +
                      "<span>Entry 1</span>" +
                      "</p>"));
  }

• getExportXhtmlTransitional/setExportXhtmlTransitional

  public boolean getExportXhtmlTransitional() / public void setExportXhtmlTransitional(boolean value)
  

  Specifies whether to write the DOCTYPE declaration when saving to HTML or MHTML. When true, writes a DOCTYPE declaration in the document prior to the root element. Default value is false. When saving to EPUB or HTML5 (HtmlVersion.HTML_5) the DOCTYPE declaration is always written.

  Aspose.Words always writes well formed HTML regardless of this setting.

  When true, the beginning of the HTML output document will look like this:

              <?xml version="1.0" encoding="utf-8" standalone="no" ?>
              <!DOCTYPE html 
                    PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
              "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
              <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
              

  Aspose.Words aims to output XHTML according to the XHTML 1.0 Transitional specification, but the output will not always validate against the DTD. Some structures inside a Microsoft Word document are hard or impossible to map to a document that will validate against the XHTML schema. For example, XHTML does not allow nested lists (UL cannot be nested inside another UL element), but in Microsoft Word document multilevel lists occur quite often.

  Example:

  Shows how to display a DOCTYPE heading when converting documents to the Xhtml 1.0 transitional standard.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.writeln("Hello world!");
  
  HtmlSaveOptions options = new HtmlSaveOptions(SaveFormat.HTML);
  {
      options.setHtmlVersion(HtmlVersion.XHTML);
      options.setExportXhtmlTransitional(showDoctypeDeclaration);
      options.setPrettyFormat(true);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.ExportXhtmlTransitional.html", options);
  
  // Our document will only contain a DOCTYPE declaration heading if we have set the "ExportXhtmlTransitional" flag to "true".
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.ExportXhtmlTransitional.html"), StandardCharsets.UTF_8);
  
  if (showDoctypeDeclaration)
      Assert.assertTrue(outDocContents.contains(
              "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"no\"?>\r\n" +
                      "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\r\n" +
                      "<html xmlns=\"http://www.w3.org/1999/xhtml\">"));
  else
      Assert.assertTrue(outDocContents.contains("<html>"));

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

• getFontResourcesSubsettingSizeThreshold/setFontResourcesSubsettingSizeThreshold

  public int getFontResourcesSubsettingSizeThreshold() / public void setFontResourcesSubsettingSizeThreshold(int value)
  

  Controls which font resources need subsetting when saving to HTML, MHTML or EPUB. Default is 0.

  ExportFontResources allows exporting fonts as subsidiary files or as parts of the output package. If the document uses many fonts, especially with large number of glyphs, then output size can grow significantly. Font subsetting reduces the size of the exported font resource by filtering out glyphs that are not used by the current document.

  Font subsetting works as follows:

  • By default, all exported fonts are subsetted.
  • Setting FontResourcesSubsettingSizeThreshold to a positive value instructs Aspose.Words to subset fonts which file size is larger than the specified value.
  • Setting the property to java.lang.Integer.MAX_VALUE suppresses font subsetting.

  Important! When exporting font resources, font licensing issues should be considered. Authors who want to use specific fonts via a downloadable font mechanism must always carefully verify that their intended use is within the scope of the font license. Many commercial fonts presently do not allow web downloading of their fonts in any form. License agreements that cover some fonts specifically note that usage via @font-face rules in CSS style sheets is not allowed. Font subsetting can also violate license terms.

  Example:

  Shows how to work with font subsetting.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.getFont().setName("Arial");
  builder.writeln("Hello world!");
  builder.getFont().setName("Times New Roman");
  builder.writeln("Hello world!");
  builder.getFont().setName("Courier New");
  builder.writeln("Hello world!");
  
  // When we save the document to HTML, we can pass a SaveOptions object configure font subsetting.
  // Suppose we set the "ExportFontResources" flag to "true" and also name a folder in the "FontsFolder" property.
  // In that case, the saving operation will create that folder and place a .ttf file inside
  // that folder for each font that our document uses.
  // Each .ttf file will contain that font's entire glyph set,
  // which may potentially result in a very large file that accompanies the document.
  // When we apply subsetting to a font, its exported raw data will only contain the glyphs that the document is
  // using instead of the entire glyph set. If the text in our document only uses a small fraction of a font's
  // glyph set, then subsetting will significantly reduce our output documents' size.
  // We can use the "FontResourcesSubsettingSizeThreshold" property to define a .ttf file size, in bytes.
  // If an exported font creates a size bigger file than that, then the save operation will apply subsetting to that font. 
  // Setting a threshold of 0 applies subsetting to all fonts,
  // and setting it to "int.MaxValue" effectively disables subsetting.
  String fontsFolder = getArtifactsDir() + "HtmlSaveOptions.FontSubsetting.Fonts";
  
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setExportFontResources(true);
      options.setFontsFolder(fontsFolder);
      options.setFontResourcesSubsettingSizeThreshold(fontResourcesSubsettingSizeThreshold);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.FontSubsetting.html", options);
  
  File[] fontFileNames = new File(fontsFolder).listFiles((d, name) -> name.endsWith(".ttf"));
  
  Assert.assertEquals(3, fontFileNames.length);

  See Also:

  ExportFontResources

• getFontSavingCallback/setFontSavingCallback

  public IFontSavingCallback getFontSavingCallback() / public void setFontSavingCallback(IFontSavingCallback value)
  

  Allows to control how fonts are saved when a document is saved to HTML, MHTML or EPUB.

  Example:

  Shows how to define custom logic for exporting fonts when saving to HTML.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
      // Configure a SaveOptions object to export fonts to separate files.
      // Set a callback that will handle font saving in a custom manner.
      HtmlSaveOptions options = new HtmlSaveOptions();
      {
          options.setExportFontResources(true);
          options.setFontSavingCallback(new HandleFontSaving());
      }
  
      // The callback will export .ttf files and save them alongside the output document.
      doc.save(getArtifactsDir() + "HtmlSaveOptions.SaveExportedFonts.html", options);
  
      File[] fontFileNames = new File(getArtifactsDir()).listFiles((d, name) -> name.endsWith(".ttf"));
  
      for (File fontFilename : fontFileNames) {
          System.out.println(fontFilename.getName());
      }
  
  /// <summary>
  /// Prints information about exported fonts and saves them in the same local system folder as their output .html.
  /// </summary>
  public static class HandleFontSaving implements IFontSavingCallback {
      public void fontSaving(FontSavingArgs args) throws Exception {
          System.out.println(MessageFormat.format("Font:\t{0}", args.getFontFamilyName()));
          if (args.getBold()) System.out.print(", bold");
          if (args.getItalic()) System.out.print(", italic");
          System.out.println(MessageFormat.format("\nSource:\t{0}, {1} bytes\n", args.getOriginalFileName(), args.getOriginalFileSize()));
  
          // We can also access the source document from here.
          Assert.assertTrue(args.getDocument().getOriginalFileName().endsWith("Rendering.docx"));
  
          Assert.assertTrue(args.isExportNeeded());
          Assert.assertTrue(args.isSubsettingNeeded());
  
          String[] splittedFileName = args.getOriginalFileName().split("\\\\");
          String fileName = splittedFileName[splittedFileName.length - 1];
  
          // There are two ways of saving an exported font.
          // 1 -  Save it to a local file system location:
          args.setFontFileName(fileName);
  
          // 2 -  Save it to a stream:
          args.setFontStream(new FileOutputStream(fileName));
          Assert.assertFalse(args.getKeepFontStreamOpen());
      }
  }

• getFontsFolder/setFontsFolder

  public java.lang.String getFontsFolder() / public void setFontsFolder(java.lang.String value)
  

  Specifies the physical folder where fonts are saved when exporting a document to HTML. Default is an empty string.

  When you save a Document in HTML format and ExportFontResources is set to true, Aspose.Words needs to save fonts used in the document as standalone files. FontsFolder allows you to specify where the fonts will be saved and FontsFolderAlias allows to specify how the font URIs will be constructed.

  If you save a document into a file and provide a file name, Aspose.Words, by default, saves the fonts in the same folder where the document file is saved. Use FontsFolder to override this behavior.

  If you save a document into a stream, Aspose.Words does not have a folder where to save the fonts, but still needs to save the fonts somewhere. In this case, you need to specify an accessible folder in the FontsFolder property or provide custom streams via the FontSavingCallback event handler.

  If the folder specified by FontsFolder doesn't exist, it will be created automatically.

  ResourceFolder is another way to specify a folder where fonts should be saved.

  Example:

  Shows how to set folders and folder aliases for externally saved resources that Aspose.Words will create when saving a document to HTML.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setCssStyleSheetType(CssStyleSheetType.EXTERNAL);
      options.setExportFontResources(true);
      options.setImageResolution(72);
      options.setFontResourcesSubsettingSizeThreshold(0);
      options.setFontsFolder(getArtifactsDir() + "Fonts");
      options.setImagesFolder(getArtifactsDir() + "Images");
      options.setResourceFolder(getArtifactsDir() + "Resources");
      options.setFontsFolderAlias("http://example.com/fonts");
      options.setImagesFolderAlias("http://example.com/images");
      options.setResourceFolderAlias("http://example.com/resources");
      options.setExportOriginalUrlForLinkedImages(true);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.FolderAlias.html", options);

  See Also:

  ResourceFolder, ExportFontResources, FontsFolderAlias, FontSavingCallback

• getFontsFolderAlias/setFontsFolderAlias

  public java.lang.String getFontsFolderAlias() / public void setFontsFolderAlias(java.lang.String value)
  

  Specifies the name of the folder used to construct font URIs written into an HTML document. Default is an empty string.

  When you save a Document in HTML format and ExportFontResources is set to true, Aspose.Words needs to save fonts used in the document as standalone files. FontsFolder allows you to specify where the fonts will be saved and FontsFolderAlias allows to specify how the font URIs will be constructed.

  If FontsFolderAlias is not an empty string, then the font URI written to HTML will be FontsFolderAlias + <font file name>.

  If FontsFolderAlias is an empty string, then the font URI written to HTML will be FontsFolder + <font file name>.

  If FontsFolderAlias is set to '.' (dot), then the font file name will be written to HTML without path regardless of other options.

  Alternative way to specify the name of the folder to construct font URIs is to use ResourceFolderAlias.

  Example:

  Shows how to set folders and folder aliases for externally saved resources that Aspose.Words will create when saving a document to HTML.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setCssStyleSheetType(CssStyleSheetType.EXTERNAL);
      options.setExportFontResources(true);
      options.setImageResolution(72);
      options.setFontResourcesSubsettingSizeThreshold(0);
      options.setFontsFolder(getArtifactsDir() + "Fonts");
      options.setImagesFolder(getArtifactsDir() + "Images");
      options.setResourceFolder(getArtifactsDir() + "Resources");
      options.setFontsFolderAlias("http://example.com/fonts");
      options.setImagesFolderAlias("http://example.com/images");
      options.setResourceFolderAlias("http://example.com/resources");
      options.setExportOriginalUrlForLinkedImages(true);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.FolderAlias.html", options);

  See Also:

  ResourceFolderAlias, ExportFontResources, FontsFolder, FontSavingCallback

• getHtmlVersion/setHtmlVersion

  public int getHtmlVersion() / public void setHtmlVersion(int value)
  

  Specifies version of HTML standard that should be used when saving the document to HTML or MHTML. Default value is HtmlVersion.XHTML. The value of the property is HtmlVersion integer constant.

  Example:

  Shows how to display a DOCTYPE heading when converting documents to the Xhtml 1.0 transitional standard.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.writeln("Hello world!");
  
  HtmlSaveOptions options = new HtmlSaveOptions(SaveFormat.HTML);
  {
      options.setHtmlVersion(HtmlVersion.XHTML);
      options.setExportXhtmlTransitional(showDoctypeDeclaration);
      options.setPrettyFormat(true);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.ExportXhtmlTransitional.html", options);
  
  // Our document will only contain a DOCTYPE declaration heading if we have set the "ExportXhtmlTransitional" flag to "true".
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.ExportXhtmlTransitional.html"), StandardCharsets.UTF_8);
  
  if (showDoctypeDeclaration)
      Assert.assertTrue(outDocContents.contains(
              "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"no\"?>\r\n" +
                      "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\r\n" +
                      "<html xmlns=\"http://www.w3.org/1999/xhtml\">"));
  else
      Assert.assertTrue(outDocContents.contains("<html>"));

  Example:

  Shows how to save a document to a specific version of HTML.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  HtmlSaveOptions options = new HtmlSaveOptions(SaveFormat.HTML);
  {
      options.setHtmlVersion(htmlVersion);
      options.setPrettyFormat(true);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.HtmlVersions.html", options);
  
  // Our HTML documents will have minor differences to be compatible with different HTML versions.
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.HtmlVersions.html"), StandardCharsets.UTF_8);
  
  switch (htmlVersion) {
      case HtmlVersion.HTML_5:
          Assert.assertTrue(outDocContents.contains("<a id=\"_Toc76372689\"></a>"));
          Assert.assertTrue(outDocContents.contains("<a id=\"_Toc76372689\"></a>"));
          Assert.assertTrue(outDocContents.contains("<table style=\"-aw-border-insideh:0.5pt single #000000; -aw-border-insidev:0.5pt single #000000; border-collapse:collapse\">"));
          break;
      case HtmlVersion.XHTML:
          Assert.assertTrue(outDocContents.contains("<a name=\"_Toc76372689\"></a>"));
          Assert.assertTrue(outDocContents.contains("<ul type=\"disc\" style=\"margin:0pt; padding-left:0pt\">"));
          Assert.assertTrue(outDocContents.contains("<table cellspacing=\"0\" cellpadding=\"0\" style=\"-aw-border-insideh:0.5pt single #000000; -aw-border-insidev:0.5pt single #000000; border-collapse:collapse\">"));
          break;
  }

• getImageResolution/setImageResolution

  public int getImageResolution() / public void setImageResolution(int value)
  

  Specifies the output resolution for images when exporting to HTML, MHTML or EPUB. Default is 96 dpi.

  This property effects raster images when ScaleImageToShapeSize is true and effects metafiles exported as raster images. Some image properties such as cropping or rotation require saving transformed images and in this case transformed images are created in the given resolution.

  Example:

  Shows how to set folders and folder aliases for externally saved resources that Aspose.Words will create when saving a document to HTML.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setCssStyleSheetType(CssStyleSheetType.EXTERNAL);
      options.setExportFontResources(true);
      options.setImageResolution(72);
      options.setFontResourcesSubsettingSizeThreshold(0);
      options.setFontsFolder(getArtifactsDir() + "Fonts");
      options.setImagesFolder(getArtifactsDir() + "Images");
      options.setResourceFolder(getArtifactsDir() + "Resources");
      options.setFontsFolderAlias("http://example.com/fonts");
      options.setImagesFolderAlias("http://example.com/images");
      options.setResourceFolderAlias("http://example.com/resources");
      options.setExportOriginalUrlForLinkedImages(true);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.FolderAlias.html", options);

  See Also:

  ScaleImageToShapeSize

• getImageSavingCallback/setImageSavingCallback

  public IImageSavingCallback getImageSavingCallback() / public void setImageSavingCallback(IImageSavingCallback value)
  

  Allows to control how images are saved when a document is saved to HTML, MHTML or EPUB.

  Example:

  Shows how to split a document into parts and save them.

  Document doc = new Document(getMyDir() + "Rendering.docx");
      String outFileName = "SavingCallback.DocumentPartsFileNames.html";
  
      // Create an "HtmlFixedSaveOptions" object, which we can pass to the document's "Save" method
      // to modify how we convert the document to HTML.
      HtmlSaveOptions options = new HtmlSaveOptions();
  
      // If we save the document normally, there will be one output HTML
      // document with all the source document's contents.
      // Set the "DocumentSplitCriteria" property to "DocumentSplitCriteria.SectionBreak" to
      // save our document to multiple HTML files: one for each section.
      options.setDocumentSplitCriteria(DocumentSplitCriteria.SECTION_BREAK);
  
      // Assign a custom callback to the "DocumentPartSavingCallback" property to alter the document part saving logic.
      options.setDocumentPartSavingCallback(new SavedDocumentPartRename(outFileName, options.getDocumentSplitCriteria()));
  
      // If we convert a document that contains images into html, we will end up with one html file which links to several images.
      // Each image will be in the form of a file in the local file system.
      // There is also a callback that can customize the name and file system location of each image.
      options.setImageSavingCallback(new SavedImageRename(outFileName));
  
      doc.save(getArtifactsDir() + outFileName, options);
  }
  
  /// <summary>
  /// Sets custom filenames for output documents that the saving operation splits a document into.
  /// </summary>
  private static class SavedDocumentPartRename implements IDocumentPartSavingCallback {
      public SavedDocumentPartRename(String outFileName, int documentSplitCriteria) {
          mOutFileName = outFileName;
          mDocumentSplitCriteria = documentSplitCriteria;
      }
  
      public void documentPartSaving(DocumentPartSavingArgs args) throws Exception {
          // We can access the entire source document via the "Document" property.
          Assert.assertTrue(args.getDocument().getOriginalFileName().endsWith("Rendering.docx"));
  
          String partType = "";
  
          switch (mDocumentSplitCriteria) {
              case DocumentSplitCriteria.PAGE_BREAK:
                  partType = "Page";
                  break;
              case DocumentSplitCriteria.COLUMN_BREAK:
                  partType = "Column";
                  break;
              case DocumentSplitCriteria.SECTION_BREAK:
                  partType = "Section";
                  break;
              case DocumentSplitCriteria.HEADING_PARAGRAPH:
                  partType = "Paragraph from heading";
                  break;
          }
  
          String partFileName = MessageFormat.format("{0} part {1}, of type {2}.{3}", mOutFileName, ++mCount, partType, FilenameUtils.getExtension(args.getDocumentPartFileName()));
  
          // Below are two ways of specifying where Aspose.Words will save each part of the document.
          // 1 -  Set a filename for the output part file:
          args.setDocumentPartFileName(partFileName);
  
          // 2 -  Create a custom stream for the output part file:
          try (FileOutputStream outputStream = new FileOutputStream(getArtifactsDir() + partFileName)) {
              args.setDocumentPartStream(outputStream);
          }
  
          Assert.assertNotNull(args.getDocumentPartStream());
          Assert.assertFalse(args.getKeepDocumentPartStreamOpen());
      }
  
      private int mCount;
      private final String mOutFileName;
      private final int mDocumentSplitCriteria;
  }
  
  /// <summary>
  /// Sets custom filenames for image files that an HTML conversion creates.
  /// </summary>
  public static class SavedImageRename implements IImageSavingCallback {
      public SavedImageRename(String outFileName) {
          mOutFileName = outFileName;
      }
  
      public void imageSaving(ImageSavingArgs args) throws Exception {
          String imageFileName = MessageFormat.format("{0} shape {1}, of type {2}.{3}", mOutFileName, ++mCount, args.getCurrentShape().getShapeType(), FilenameUtils.getExtension(args.getImageFileName()));
  
          // Below are two ways of specifying where Aspose.Words will save each part of the document.
          // 1 -  Set a filename for the output image file:
          args.setImageFileName(imageFileName);
  
          // 2 -  Create a custom stream for the output image file:
          args.setImageStream(new FileOutputStream(getArtifactsDir() + imageFileName));
  
          Assert.assertNotNull(args.getImageStream());
          Assert.assertTrue(args.isImageAvailable());
          Assert.assertFalse(args.getKeepImageStreamOpen());
      }
  
      private int mCount;
      private final String mOutFileName;
  }

• getImagesFolder/setImagesFolder

  public java.lang.String getImagesFolder() / public void setImagesFolder(java.lang.String value)
  

  Specifies the physical folder where images are saved when exporting a document to HTML format. Default is an empty string.

  When you save a Document in HTML format, Aspose.Words needs to save all images embedded in the document as standalone files. ImagesFolder allows you to specify where the images will be saved and ImagesFolderAlias allows to specify how the image URIs will be constructed.

  If you save a document into a file and provide a file name, Aspose.Words, by default, saves the images in the same folder where the document file is saved. Use ImagesFolder to override this behavior.

  If you save a document into a stream, Aspose.Words does not have a folder where to save the images, but still needs to save the images somewhere. In this case, you need to specify an accessible folder in the ImagesFolder property or provide custom streams via the ImageSavingCallback event handler.

  If the folder specified by ImagesFolder doesn't exist, it will be created automatically.

  ResourceFolder is another way to specify a folder where images should be saved.

  Example:

  Shows how to specify the folder for storing linked images after saving to .html.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  File imagesDir = new File(getArtifactsDir() + "SaveHtmlWithOptions");
  
  if (imagesDir.exists())
      imagesDir.delete();
  
  imagesDir.mkdir();
  
  // Set an option to export form fields as plain text instead of HTML input elements.
  HtmlSaveOptions options = new HtmlSaveOptions(SaveFormat.HTML);
  options.setExportTextInputFormFieldAsText(true);
  options.setImagesFolder(imagesDir.getPath());
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.SaveHtmlWithOptions.html", options);

  See Also:

  ResourceFolder, ImagesFolderAlias, ImageSavingCallback

• getImagesFolderAlias/setImagesFolderAlias

  public java.lang.String getImagesFolderAlias() / public void setImagesFolderAlias(java.lang.String value)
  

  Specifies the name of the folder used to construct image URIs written into an HTML document. Default is an empty string.

  When you save a Document in HTML format, Aspose.Words needs to save all images embedded in the document as standalone files. ImagesFolder allows you to specify where the images will be saved and ImagesFolderAlias allows to specify how the image URIs will be constructed.

  If ImagesFolderAlias is not an empty string, then the image URI written to HTML will be ImagesFolderAlias + <image file name>.

  If ImagesFolderAlias is an empty string, then the image URI written to HTML will be ImagesFolder + <image file name>.

  If ImagesFolderAlias is set to '.' (dot), then the image file name will be written to HTML without path regardless of other options.

  Alternative way to specify the name of the folder to construct image URIs is to use ResourceFolderAlias.

  Example:

  Shows how to set folders and folder aliases for externally saved resources that Aspose.Words will create when saving a document to HTML.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setCssStyleSheetType(CssStyleSheetType.EXTERNAL);
      options.setExportFontResources(true);
      options.setImageResolution(72);
      options.setFontResourcesSubsettingSizeThreshold(0);
      options.setFontsFolder(getArtifactsDir() + "Fonts");
      options.setImagesFolder(getArtifactsDir() + "Images");
      options.setResourceFolder(getArtifactsDir() + "Resources");
      options.setFontsFolderAlias("http://example.com/fonts");
      options.setImagesFolderAlias("http://example.com/images");
      options.setResourceFolderAlias("http://example.com/resources");
      options.setExportOriginalUrlForLinkedImages(true);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.FolderAlias.html", options);

  See Also:

  ResourceFolderAlias, ImagesFolder, ImageSavingCallback

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

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

• getMetafileFormat/setMetafileFormat

  public int getMetafileFormat() / public void setMetafileFormat(int value)
  

  Specifies in what format metafiles are saved when exporting to HTML, MHTML, or EPUB. Default value is HtmlMetafileFormat.PNG, meaning that metafiles are rendered to raster PNG images. The value of the property is HtmlMetafileFormat integer constant.

  Metafiles are not natively displayed by HTML browsers. By default, Aspose.Words converts WMF and EMF images into PNG files when exporting to HTML. Other options are to convert metafiles to SVG images or to export them as is without conversion.

  Some image transforms, in particular image cropping, will not be applied to metafile images if they are exported to HTML without conversion.

  Example:

  Shows how to convert SVG objects to a different format when saving HTML documents.

  String html =
          "<html>\r\n                    <svg xmlns='http://www.w3.org/2000/svg' width='500' height='40' viewBox='0 0 500 40'>\r\n                        <text x='0' y='35' font-family='Verdana' font-size='35'>Hello world!</text>\r\n                    </svg>\r\n                </html>";
  
  Document doc = new Document(new ByteArrayInputStream(html.getBytes()));
  
  // This document contains a <svg> element in the form of text.
  // When we save the document to HTML, we can pass a SaveOptions object
  // to determine how the saving operation handles this object.
  // Setting the "MetafileFormat" property to "HtmlMetafileFormat.Png" to convert it to a PNG image.
  // Setting the "MetafileFormat" property to "HtmlMetafileFormat.Svg" preserve it as a SVG object.
  // Setting the "MetafileFormat" property to "HtmlMetafileFormat.EmfOrWmf" to convert it to a metafile.
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setMetafileFormat(htmlMetafileFormat);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.MetafileFormat.html", options);
  
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.MetafileFormat.html"), StandardCharsets.UTF_8);
  
  switch (htmlMetafileFormat) {
      case HtmlMetafileFormat.PNG:
          Assert.assertTrue(outDocContents.contains(
                  "<p style=\"margin-top:0pt; margin-bottom:0pt\">" +
                          "<img src=\"HtmlSaveOptions.MetafileFormat.001.png\" width=\"501\" height=\"41\" alt=\"\" " +
                          "style=\"-aw-left-pos:0pt; -aw-rel-hpos:column; -aw-rel-vpos:paragraph; -aw-top-pos:0pt; -aw-wrap-type:inline\" />" +
                          "</p>"));
          break;
      case HtmlMetafileFormat.SVG:
          Assert.assertTrue(outDocContents.contains(
                  "<span style=\"-aw-left-pos:0pt; -aw-rel-hpos:column; -aw-rel-vpos:paragraph; -aw-top-pos:0pt; -aw-wrap-type:inline\">" +
                          "<svg xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"1.1\" width=\"499\" height=\"40\">"));
          break;
      case HtmlMetafileFormat.EMF_OR_WMF:
          Assert.assertTrue(outDocContents.contains(
                  "<p style=\"margin-top:0pt; margin-bottom:0pt\">" +
                          "<img src=\"HtmlSaveOptions.MetafileFormat.001.emf\" width=\"500\" height=\"40\" alt=\"\" " +
                          "style=\"-aw-left-pos:0pt; -aw-rel-hpos:column; -aw-rel-vpos:paragraph; -aw-top-pos:0pt; -aw-wrap-type:inline\" />" +
                          "</p>"));
          break;
  }

  See Also:

  ImageResolution, ScaleImageToShapeSize

• getOfficeMathOutputMode/setOfficeMathOutputMode

  public int getOfficeMathOutputMode() / public void setOfficeMathOutputMode(int value)
  

  Controls how OfficeMath objects are exported to HTML, MHTML or EPUB. Default value is HtmlOfficeMathOutputMode.Image. The value of the property is HtmlOfficeMathOutputMode integer constant.

  Example:

  Shows how to specify how to export Microsoft OfficeMath objects to HTML.

  Document doc = new Document(getMyDir() + "Office math.docx");
  
  // When we save the document to HTML, we can pass a SaveOptions object
  // to determine how the saving operation handles OfficeMath objects.
  // Setting the "OfficeMathOutputMode" property to "HtmlOfficeMathOutputMode.Image"
  // will render each OfficeMath object into an image.
  // Setting the "OfficeMathOutputMode" property to "HtmlOfficeMathOutputMode.MathML"
  // will convert each OfficeMath object into MathML.
  // Setting the "OfficeMathOutputMode" property to "HtmlOfficeMathOutputMode.Text"
  // will represent each OfficeMath formula using plain HTML text.
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setOfficeMathOutputMode(htmlOfficeMathOutputMode);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.OfficeMathOutputMode.html", options);

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

• getResolveFontNames/setResolveFontNames

  public boolean getResolveFontNames() / public void setResolveFontNames(boolean value)
  

  Specifies whether font family names used in the document are resolved and substituted according to Document.FontSettings when being written into HTML-based formats.

  By default, this option is set to false and font family names are written to HTML as specified in source documents. That is, Document.FontSettings are ignored and no resolution or substitution of font family names is performed.

  If this option is set to true, Aspose.Words uses Document.FontSettings to resolve each font family name specified in a source document into the name of an available font family, performing font substitution as required.

  Example:

  Shows how to resolve all font names before writing them to HTML.

  Document doc = new Document(getMyDir() + "Missing font.docx");
  
  // This document contains text that names a font that we do not have.
  Assert.assertNotNull(doc.getFontInfos().get("28 Days Later"));
  
  // If we have no way of getting this font, and we want to be able to display all the text
  // in this document in an output HTML, we can substitute it with another font.
  FontSettings fontSettings = new FontSettings();
  {
      fontSettings.getSubstitutionSettings().getDefaultFontSubstitution().setDefaultFontName("Arial");
      fontSettings.getSubstitutionSettings().getDefaultFontSubstitution().setEnabled(true);
  }
  
  doc.setFontSettings(fontSettings);
  
  HtmlSaveOptions saveOptions = new HtmlSaveOptions(SaveFormat.HTML);
  {
      // By default, this option is set to 'False' and Aspose.Words writes font names as specified in the source document.
      saveOptions.setResolveFontNames(resolveFontNames);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.ResolveFontNames.html", saveOptions);
  
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.ResolveFontNames.html"), "utf-8");
  
  Assert.assertTrue(outDocContents.matches("<span style=\"font-family:Arial\">"));

• getResourceFolder/setResourceFolder

  public java.lang.String getResourceFolder() / public void setResourceFolder(java.lang.String value)
  

  Specifies a physical folder where all resources like images, fonts, and external CSS are saved when a document is exported to HTML. Default is an empty string.

  ResourceFolder is the simplest way to specify a folder where all resources should be written. Another way is to use individual properties FontsFolder, ImagesFolder, and CssStyleSheetFileName.

  ResourceFolder has a lower priority than folders specified via FontsFolder, ImagesFolder, and CssStyleSheetFileName. For example, if both ResourceFolder and FontsFolder are specified, fonts will be saved to FontsFolder, while images and CSS will be saved to ResourceFolder.

  If the folder specified by ResourceFolder doesn't exist, it will be created automatically.

  Example:

  Shows how to set folders and folder aliases for externally saved resources that Aspose.Words will create when saving a document to HTML.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setCssStyleSheetType(CssStyleSheetType.EXTERNAL);
      options.setExportFontResources(true);
      options.setImageResolution(72);
      options.setFontResourcesSubsettingSizeThreshold(0);
      options.setFontsFolder(getArtifactsDir() + "Fonts");
      options.setImagesFolder(getArtifactsDir() + "Images");
      options.setResourceFolder(getArtifactsDir() + "Resources");
      options.setFontsFolderAlias("http://example.com/fonts");
      options.setImagesFolderAlias("http://example.com/images");
      options.setResourceFolderAlias("http://example.com/resources");
      options.setExportOriginalUrlForLinkedImages(true);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.FolderAlias.html", options);

  See Also:

  FontsFolder, ImagesFolder, CssStyleSheetFileName

• getResourceFolderAlias/setResourceFolderAlias

  public java.lang.String getResourceFolderAlias() / public void setResourceFolderAlias(java.lang.String value)
  

  Specifies the name of the folder used to construct URIs of all resources written into an HTML document. Default is an empty string.

  ResourceFolderAlias is the simplest way to specify how URIs for all resource files should be constructed. Same information can be specified for images and fonts separately via ImagesFolderAlias and FontsFolderAlias properties, respectively. However, there is no individual property for CSS.

  ResourceFolderAlias has lower priority than FontsFolderAlias and ImagesFolderAlias. For example, if both ResourceFolderAlias and FontsFolderAlias are specified, fonts' URIs will be constructed using FontsFolderAlias, while URIs of images and CSS will be constructed using ResourceFolderAlias.

  If ResourceFolderAlias is empty, the ResourceFolder property value will be used to construct resource URIs.

  If ResourceFolderAlias is set to '.' (dot), resource URIs will contain file names only, without any path.

  Example:

  Shows how to set folders and folder aliases for externally saved resources that Aspose.Words will create when saving a document to HTML.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setCssStyleSheetType(CssStyleSheetType.EXTERNAL);
      options.setExportFontResources(true);
      options.setImageResolution(72);
      options.setFontResourcesSubsettingSizeThreshold(0);
      options.setFontsFolder(getArtifactsDir() + "Fonts");
      options.setImagesFolder(getArtifactsDir() + "Images");
      options.setResourceFolder(getArtifactsDir() + "Resources");
      options.setFontsFolderAlias("http://example.com/fonts");
      options.setImagesFolderAlias("http://example.com/images");
      options.setResourceFolderAlias("http://example.com/resources");
      options.setExportOriginalUrlForLinkedImages(true);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.FolderAlias.html", options);

  See Also:

  ResourceFolder, FontsFolderAlias, ImagesFolderAlias

• 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.HTML, SaveFormat.MHTML or SaveFormat.EPUB. The value of the property is SaveFormat integer constant.

  Example:

  Shows how to use a specific encoding when saving a document to .epub.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // Use a SaveOptions object to specify the encoding for a document that we will save.
  HtmlSaveOptions saveOptions = new HtmlSaveOptions();
  saveOptions.setSaveFormat(SaveFormat.EPUB);
  saveOptions.setEncoding(StandardCharsets.UTF_8);
  
  // By default, an output .epub document will have all of its contents in one HTML part.
  // A split criterion allows us to segment the document into several HTML parts.
  // We will set the criteria to split the document into heading paragraphs.
  // This is useful for readers who cannot read HTML files more significant than a specific size.
  saveOptions.setDocumentSplitCriteria(DocumentSplitCriteria.HEADING_PARAGRAPH);
  
  // Specify that we want to export document properties.
  saveOptions.setExportDocumentProperties(true);
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.Doc2EpubSaveOptions.epub", saveOptions);

• getScaleImageToShapeSize/setScaleImageToShapeSize

  public boolean getScaleImageToShapeSize() / public void setScaleImageToShapeSize(boolean value)
  

  Specifies whether images are scaled by Aspose.Words to the bounding shape size when exporting to HTML, MHTML or EPUB. Default value is true.

  An image in a Microsoft Word document is a shape. The shape has a size and the image has its own size. The sizes are not directly linked. For example, the image can be 1024x786 pixels, but shape that displays this image can be 400x300 points.

  In order to display an image in the browser, it must be scaled to the shape size. The ScaleImageToShapeSize property controls where the scaling of the image takes place: in Aspose.Words during export to HTML or in the browser when displaying the document.

  When ScaleImageToShapeSize is true, the image is scaled by Aspose.Words using high quality scaling during export to HTML. When ScaleImageToShapeSize is false, the image is output with its original size and the browser has to scale it.

  In general, browsers do quick and poor quality scaling. As a result, you will normally get better display quality in the browser and smaller file size when ScaleImageToShapeSize is true, but better printing quality and faster conversion when ScaleImageToShapeSize is false.

  Example:

  Shows how to disable the scaling of images to their parent shape dimensions when saving to .html.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert a shape which contains an image, and then make that shape considerably smaller than the image.
  BufferedImage image = ImageIO.read(new File(getImageDir() + "Transparent background logo.png"));
  
  Assert.assertEquals(400, image.getWidth());
  Assert.assertEquals(400, image.getHeight());
  
  Shape imageShape = builder.insertImage(image);
  imageShape.setWidth(50.0);
  imageShape.setHeight(50.0);
  
  // Saving a document that contains shapes with images to HTML will create an image file in the local file system
  // for each such shape. The output HTML document will use <image> tags to link to and display these images.
  // When we save the document to HTML, we can pass a SaveOptions object to determine
  // whether to scale all images that are inside shapes to the sizes of their shapes.
  // Setting the "ScaleImageToShapeSize" flag to "true" will shrink every image
  // to the size of the shape that contains it, so that no saved images will be larger than the document requires them to be.
  // Setting the "ScaleImageToShapeSize" flag to "false" will preserve these images' original sizes,
  // which will take up more space in exchange for preserving image quality.
  HtmlSaveOptions options = new HtmlSaveOptions();
  {
      options.setScaleImageToShapeSize(scaleImageToShapeSize);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.ScaleImageToShapeSize.html", options);

  See Also:

  ImageResolution

• getTableWidthOutputMode/setTableWidthOutputMode

  public int getTableWidthOutputMode() / public void setTableWidthOutputMode(int value)
  

  Controls how table, row and cell widths are exported to HTML, MHTML or EPUB. Default value is HtmlElementSizeOutputMode.ALL. The value of the property is HtmlElementSizeOutputMode integer constant.

  In the HTML format, table, row and cell elements (<table>, <tr>, <th>, <td>) can have their widths specified either in relative (percentage) or in absolute units. In a document in Aspose.Words, tables, rows and cells can have their widths specified using either relative or absolute units too.

  When you convert a document to HTML using Aspose.Words, you might want to control how table, row and cell widths are exported to affect how the resulting document is displayed in the visual agent (e.g. a browser or viewer).

  Use this property as a filter to specify what table widths values are exported into the destination document. For example, if you are converting a document to EPUB and intend to view the document on a mobile reading device, then you probably want to avoid exporting absolute width values. To do this you need to specify the output mode HtmlElementSizeOutputMode.RELATIVE_ONLY or HtmlElementSizeOutputMode.NONE so the viewer on the mobile device can layout the table to fit the width of the screen as best as it can.

  Example:

  Shows how to preserve negative indents in the output .html.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert a table with a negative indent, which will push it to the left past the left page boundary.
  Table table = builder.startTable();
  builder.insertCell();
  builder.write("Row 1, Cell 1");
  builder.insertCell();
  builder.write("Row 1, Cell 2");
  builder.endTable();
  table.setLeftIndent(-36);
  table.setPreferredWidth(PreferredWidth.fromPoints(144.0));
  
  builder.insertBreak(BreakType.PARAGRAPH_BREAK);
  
  // Insert a table with a positive indent, which will push the table to the right.
  table = builder.startTable();
  builder.insertCell();
  builder.write("Row 1, Cell 1");
  builder.insertCell();
  builder.write("Row 1, Cell 2");
  builder.endTable();
  table.setLeftIndent(36.0);
  table.setPreferredWidth(PreferredWidth.fromPoints(144.0));
  
  // When we save a document to HTML, Aspose.Words will only preserve negative indents
  // such as the one we have applied to the first table if we set the "AllowNegativeIndent" flag
  // in a SaveOptions object that we will pass to "true".
  HtmlSaveOptions options = new HtmlSaveOptions(SaveFormat.HTML);
  {
      options.setAllowNegativeIndent(allowNegativeIndent);
      options.setTableWidthOutputMode(HtmlElementSizeOutputMode.RELATIVE_ONLY);
  }
  
  doc.save(getArtifactsDir() + "HtmlSaveOptions.NegativeIndent.html", options);
  
  String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.NegativeIndent.html"), StandardCharsets.UTF_8);
  
  if (allowNegativeIndent) {
      Assert.assertTrue(outDocContents.contains(
              "<table cellspacing=\"0\" cellpadding=\"0\" style=\"margin-left:-41.65pt; border:0.75pt solid #000000; -aw-border:0.5pt single; -aw-border-insideh:0.5pt single #000000; -aw-border-insidev:0.5pt single #000000; border-collapse:collapse\">"));
      Assert.assertTrue(outDocContents.contains(
              "<table cellspacing=\"0\" cellpadding=\"0\" style=\"margin-left:30.35pt; border:0.75pt solid #000000; -aw-border:0.5pt single; -aw-border-insideh:0.5pt single #000000; -aw-border-insidev:0.5pt single #000000; border-collapse:collapse\">"));
  } else {
      Assert.assertTrue(outDocContents.contains(
              "<table cellspacing=\"0\" cellpadding=\"0\" style=\"border:0.75pt solid #000000; -aw-border:0.5pt single; -aw-border-insideh:0.5pt single #000000; -aw-border-insidev:0.5pt single #000000; border-collapse:collapse\">"));
      Assert.assertTrue(outDocContents.contains(
              "<table cellspacing=\"0\" cellpadding=\"0\" style=\"margin-left:30.35pt; border:0.75pt solid #000000; -aw-border:0.5pt single; -aw-border-insideh:0.5pt single #000000; -aw-border-insidev:0.5pt single #000000; border-collapse:collapse\">"));
  }

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

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