com.aspose.words

Class HtmlFixedSaveOptions

public class HtmlFixedSaveOptions 
extends FixedPageSaveOptions

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

Example:

Shows how to use a callback to print the URIs of external resources created while converting a document to HTML.
public void htmlFixedResourceFolder() throws Exception {
    Document doc = new Document(getMyDir() + "Rendering.docx");

    ResourceUriPrinter callback = new ResourceUriPrinter();

    HtmlFixedSaveOptions options = new HtmlFixedSaveOptions();
    {
        options.setSaveFormat(SaveFormat.HTML_FIXED);
        options.setExportEmbeddedImages(false);
        options.setResourcesFolder(getArtifactsDir() + "HtmlFixedResourceFolder");
        options.setResourcesFolderAlias(getArtifactsDir() + "HtmlFixedResourceFolderAlias");
        options.setShowPageBorder(false);
        options.setResourceSavingCallback(callback);
    }

    // A folder specified by ResourcesFolderAlias will contain the resources instead of ResourcesFolder.
    // We must ensure the folder exists before the streams can put their resources into it.
    new File(options.getResourcesFolderAlias()).mkdir();

    doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.HtmlFixedResourceFolder.html", options);

    System.out.println(callback.getText());

    String[] resourceFiles = new File(getArtifactsDir() + "HtmlFixedResourceFolderAlias").list();

    Assert.assertFalse(new File(getArtifactsDir() + "HtmlFixedResourceFolder").exists());
    Assert.assertEquals(6, IterableUtils.countMatches(Arrays.asList(resourceFiles),
            f -> f.endsWith(".jpeg") || f.endsWith(".png") || f.endsWith(".css")));
}

/// <summary>
/// Counts and prints URIs of resources contained by as they are converted to fixed .Html.
/// </summary>
private static class ResourceUriPrinter implements IResourceSavingCallback {
    public void resourceSaving(ResourceSavingArgs args) throws Exception {
        // If we set a folder alias in the SaveOptions object, we will be able to print it from here.
        mText.append(MessageFormat.format("Resource #{0} \"{1}\"", ++mSavedResourceCount, args.getResourceFileName()));

        String extension = FilenameUtils.getExtension(args.getResourceFileName());
        switch (extension) {
            case "ttf":
            case "woff": {
                // By default, 'ResourceFileUri' uses system folder for fonts.
                // To avoid problems in other platforms you must explicitly specify the path for the fonts.
                args.setResourceFileUri(getArtifactsDir() + File.separatorChar + args.getResourceFileName());
                break;
            }
        }

        mText.append("\t" + args.getResourceFileUri());

        // If we have specified a folder in the "ResourcesFolderAlias" property,
        // we will also need to redirect each stream to put its resource in that folder.
        args.setResourceStream(new FileOutputStream(args.getResourceFileUri()));
        args.setKeepResourceStreamOpen(false);
    }

    public String getText() {
        return mText.toString();
    }

    private int mSavedResourceCount;
    private final /*final*/ StringBuilder mText = new StringBuilder();
}

Constructor Summary
 
Property Getters/Setters Summary
booleangetAllowEmbeddingPostScriptFonts()
void
           Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false.
intgetColorMode()
void
setColorMode(intvalue)
           Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant.
java.lang.StringgetCssClassNamesPrefix()
void
setCssClassNamesPrefix(java.lang.Stringvalue)
           Specifies prefix which is added to all class names in style.css file. Default value is "aw".
java.lang.StringgetDefaultTemplate()
void
setDefaultTemplate(java.lang.Stringvalue)
           Gets or sets path to default template (including filename). Default value for this property is empty string.
intgetDml3DEffectsRenderingMode()
void
           Gets or sets a value determining how 3D effects are rendered. The value of the property is Dml3DEffectsRenderingMode integer constant.
intgetDmlEffectsRenderingMode()
void
           Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant.
intgetDmlRenderingMode()
void
           Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant.
java.nio.charset.CharsetgetEncoding()
void
setEncoding(java.nio.charset.Charsetvalue)
           Specifies the encoding to use when exporting to HTML. Default value is 'UTF-8' Charset.
booleangetExportEmbeddedCss()
void
setExportEmbeddedCss(booleanvalue)
           Specifies whether the CSS (Cascading Style Sheet) should be embedded into Html document.
booleangetExportEmbeddedFonts()
void
           Specifies whether fonts should be embedded into Html document in Base64 format. Note setting this flag can significantly increase size of output Html file.
booleangetExportEmbeddedImages()
void
           Specifies whether images should be embedded into Html document in Base64 format. Note setting this flag can significantly increase size of output Html file.
booleangetExportEmbeddedSvg()
void
setExportEmbeddedSvg(booleanvalue)
           Specifies whether SVG resources should be embedded into Html document. Default value is true.
booleangetExportFormFields()
void
setExportFormFields(booleanvalue)
           Gets or sets indication of whether form fields are exported as interactive items (as 'input' tag) rather than converted to text or graphics.
intgetFontFormat()
void
setFontFormat(intvalue)
           Gets or sets ExportFontFormat used for font exporting. Default value is ExportFontFormat.WOFF. The value of the property is ExportFontFormat integer constant.
intgetJpegQuality()
void
setJpegQuality(intvalue)
           Gets or sets a value determining the quality of the JPEG images inside Html document.
booleangetMemoryOptimization()
void
setMemoryOptimization(booleanvalue)
           Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false.
MetafileRenderingOptionsgetMetafileRenderingOptions()
void
           Allows to specify metafile rendering options.
intgetNumeralFormat()
void
           Gets or sets NumeralFormat used for rendering of numerals. European numerals are used by default. The value of the property is NumeralFormat integer constant.
booleangetOptimizeOutput()
void
setOptimizeOutput(booleanvalue)
           Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formating are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is true.
intgetPageHorizontalAlignment()
void
           Specifies the horizontal alignment of pages in an HTML document. Default value is HtmlFixedHorizontalPageAlignment.Center. The value of the property is HtmlFixedPageHorizontalAlignment integer constant.
doublegetPageMargins()
void
setPageMargins(doublevalue)
           Specifies the margins around pages in an HTML document. The margins value is measured in points and should be equal to or greater than 0. Default value is 10 points.
IPageSavingCallbackgetPageSavingCallback()
void
           Allows to control how separate pages are saved when a document is exported to fixed page format.
PageSetgetPageSet()
void
           Gets or sets the pages to render. Default is all the pages in the document.
booleangetPrettyFormat()
void
setPrettyFormat(booleanvalue)
           When true, pretty formats output where applicable. Default value is false.
IResourceSavingCallbackgetResourceSavingCallback()
void
           Allows to control how resources (images, fonts and css) are saved when a document is exported to fixed page Html format.
java.lang.StringgetResourcesFolder()
void
setResourcesFolder(java.lang.Stringvalue)
           Specifies the physical folder where resources (images, fonts, css) are saved when exporting a document to Html format. Default is null.
java.lang.StringgetResourcesFolderAlias()
void
setResourcesFolderAlias(java.lang.Stringvalue)
           Specifies the name of the folder used to construct image URIs written into an Html document. Default is null.
booleangetSaveFontFaceCssSeparately()
void
           Flag indicates whether "@font-face" CSS rules should be placed into a separate file "fontFaces.css" when a document is being saved with external stylesheet (that is, when ExportEmbeddedCss is false). Default value is false, all CSS rules are written into single file "styles.css".
intgetSaveFormat()
void
setSaveFormat(intvalue)
           Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.HTML_FIXED. The value of the property is SaveFormat integer constant.
booleangetShowPageBorder()
void
setShowPageBorder(booleanvalue)
           Specifies whether border around pages should be shown. Default is true.
java.lang.StringgetTempFolder()
void
setTempFolder(java.lang.Stringvalue)
           Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is null and no temporary files are used.
booleangetUpdateFields()
void
setUpdateFields(booleanvalue)
           Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true.
booleangetUpdateLastPrintedProperty()
void
           Gets or sets a value determining whether the BuiltInDocumentProperties.LastPrinted property is updated before saving.
booleangetUpdateLastSavedTimeProperty()
void
           Gets or sets a value determining whether the BuiltInDocumentProperties.LastSavedTime property is updated before saving.
booleangetUpdateSdtContent()
void
setUpdateSdtContent(booleanvalue)
           Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
booleangetUseAntiAliasing()
void
setUseAntiAliasing(booleanvalue)
           Gets or sets a value determining whether or not to use anti-aliasing for rendering.
booleangetUseHighQualityRendering()
void
           Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
booleangetUseTargetMachineFonts()
void
           Flag indicates whether fonts from target machine must be used to display the document. If this flag is set to true, FontFormat and ExportEmbeddedFonts properties do not have effect, also ResourceSavingCallback is not fired for fonts. Default is false.
 
Method Summary
booleanequals(java.lang.Object obj)
Determines whether the specified object is equal in value to the current object.
 

    • Constructor Detail

      • HtmlFixedSaveOptions

        public HtmlFixedSaveOptions()
    • 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.

      • getColorMode/setColorMode

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

        Example:

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

        public java.lang.String getCssClassNamesPrefix() / public void setCssClassNamesPrefix(java.lang.String value)
        
        Specifies prefix which is added to all class names in style.css file. Default value is "aw".

        Example:

        Shows how to place CSS into a separate file and add a prefix to all of its CSS class names.
        Document doc = new Document(getMyDir() + "Bookmarks.docx");
        
        HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions();
        {
            htmlFixedSaveOptions.setCssClassNamesPrefix("myprefix");
            htmlFixedSaveOptions.setSaveFontFaceCssSeparately(true);
        }
        
        doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.AddCssClassNamesPrefix.html", htmlFixedSaveOptions);
        
        String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlFixedSaveOptions.AddCssClassNamesPrefix.html"), "utf-8");
        
        Assert.assertTrue(outDocContents.contains("<div class=\"myprefixdiv myprefixpage\""));
      • 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.

        Example:

        Shows how to configure the rendering quality of DrawingML effects in a document as we save it to PDF.
        Document doc = new Document(getMyDir() + "DrawingML shape effects.docx");
        
        // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
        // to modify how that method converts the document to .PDF.
        PdfSaveOptions options = new PdfSaveOptions();
        
        // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.None" to discard all DrawingML effects.
        // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Simplified"
        // to render a simplified version of DrawingML effects.
        // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Fine" to
        // render DrawingML effects with more accuracy and also with more processing cost.
        options.setDmlEffectsRenderingMode(effectsRenderingMode);
        
        Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode());
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options);
      • getDmlRenderingMode/setDmlRenderingMode

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

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

        Example:

        Shows how to render fallback shapes when saving to PDF.
        Document doc = new Document(getMyDir() + "DrawingML shape fallbacks.docx");
        
        // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
        // to modify how that method converts the document to .PDF.
        PdfSaveOptions options = new PdfSaveOptions();
        
        // Set the "DmlRenderingMode" property to "DmlRenderingMode.Fallback"
        // to substitute DML shapes with their fallback shapes.
        // Set the "DmlRenderingMode" property to "DmlRenderingMode.DrawingML"
        // to render the DML shapes themselves.
        options.setDmlRenderingMode(dmlRenderingMode);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLFallback.pdf", options);

        Example:

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

        Example:

        Shows how to set which encoding to use while exporting a document to HTML.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.writeln("Hello World!");
        
        // The default encoding is UTF-8. If we want to represent our document using a different encoding,
        // we can use a SaveOptions object to set a specific encoding.
        HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions();
        htmlFixedSaveOptions.setEncoding(StandardCharsets.US_ASCII);
        
        Assert.assertEquals("US-ASCII", htmlFixedSaveOptions.getEncoding().name());
        
        doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.UseEncoding.html", htmlFixedSaveOptions);
      • getExportEmbeddedCss/setExportEmbeddedCss

        public boolean getExportEmbeddedCss() / public void setExportEmbeddedCss(boolean value)
        
        Specifies whether the CSS (Cascading Style Sheet) should be embedded into Html document.

        Example:

        Shows how to determine where to store CSS stylesheets when exporting a document to Html.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        
        // When we export a document to html, Aspose.Words will also create a CSS stylesheet to format the document with.
        // Setting the "ExportEmbeddedCss" flag to "true" save the CSS stylesheet to a .css file,
        // and link to the file from the html document using a <link> element.
        // Setting the flag to "false" will embed the CSS stylesheet within the Html document,
        // which will create only one file instead of two.
        HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions();
        {
            htmlFixedSaveOptions.setExportEmbeddedCss(exportEmbeddedCss);
        }
        
        doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.ExportEmbeddedCss.html", htmlFixedSaveOptions);
        
        String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlFixedSaveOptions.ExportEmbeddedCss.html"), "utf-8");
        
        if (exportEmbeddedCss) {
            Assert.assertTrue(outDocContents.contains("<style type=\"text/css\">"));
            Assert.assertFalse(new File(getArtifactsDir() + "HtmlFixedSaveOptions.ExportEmbeddedCss/styles.css").exists());
        } else {
            Assert.assertTrue(outDocContents.contains("<link rel=\"stylesheet\" type=\"text/css\" href=\"HtmlFixedSaveOptions.ExportEmbeddedCss/styles.css\" media=\"all\" />"));
            Assert.assertTrue(new File(getArtifactsDir() + "HtmlFixedSaveOptions.ExportEmbeddedCss/styles.css").exists());
        }
      • getExportEmbeddedFonts/setExportEmbeddedFonts

        public boolean getExportEmbeddedFonts() / public void setExportEmbeddedFonts(boolean value)
        
        Specifies whether fonts should be embedded into Html document in Base64 format. Note setting this flag can significantly increase size of output Html file.

        Example:

        Shows how to determine where to store embedded fonts when exporting a document to Html.
        Document doc = new Document(getMyDir() + "Embedded font.docx");
        
        // When we export a document with embedded fonts to .html,
        // Aspose.Words can place the fonts in two possible locations.
        // Setting the "ExportEmbeddedFonts" flag to "true" will store the raw data for embedded fonts within the CSS stylesheet,
        // in the "url" property of the "@font-face" rule. This may create a huge CSS stylesheet file
        // and reduce the number of external files that this HTML conversion will create.
        // Setting this flag to "false" will create a file for each font.
        // The CSS stylesheet will link to each font file using the "url" property of the "@font-face" rule.
        HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions();
        {
            htmlFixedSaveOptions.setExportEmbeddedFonts(exportEmbeddedFonts);
        }
        
        doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.ExportEmbeddedFonts.html", htmlFixedSaveOptions);
      • getExportEmbeddedImages/setExportEmbeddedImages

        public boolean getExportEmbeddedImages() / public void setExportEmbeddedImages(boolean value)
        
        Specifies whether images should be embedded into Html document in Base64 format. Note setting this flag can significantly increase size of output Html file.

        Example:

        Shows how to determine where to store images when exporting a document to Html.
        Document doc = new Document(getMyDir() + "Images.docx");
        
        // When we export a document with embedded images to .html,
        // Aspose.Words can place the images in two possible locations.
        // Setting the "ExportEmbeddedImages" flag to "true" will store the raw data
        // for all images within the output HTML document, in the "src" attribute of <image> tags.
        // Setting this flag to "false" will create an image file in the local file system for every image,
        // and store all these files in a separate folder.
        HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions();
        {
            htmlFixedSaveOptions.setExportEmbeddedImages(exportImages);
        }
        
        doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.ExportEmbeddedImages.html", htmlFixedSaveOptions);
      • getExportEmbeddedSvg/setExportEmbeddedSvg

        public boolean getExportEmbeddedSvg() / public void setExportEmbeddedSvg(boolean value)
        
        Specifies whether SVG resources should be embedded into Html document. Default value is true.

        Example:

        Shows how to determine where to store SVG objects when exporting a document to Html.
        Document doc = new Document(getMyDir() + "Images.docx");
        
        // When we export a document with SVG objects to .html,
        // Aspose.Words can place these objects in two possible locations.
        // Setting the "ExportEmbeddedSvg" flag to "true" will embed all SVG object raw data
        // within the output HTML, inside <image> tags.
        // Setting this flag to "false" will create a file in the local file system for each SVG object.
        // The HTML will link to each file using the "data" attribute of an <object> tag.
        HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions();
        {
            htmlFixedSaveOptions.setExportEmbeddedSvg(exportSvgs);
        }
        
        doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.ExportEmbeddedSvgs.html", htmlFixedSaveOptions);
      • getExportFormFields/setExportFormFields

        public boolean getExportFormFields() / public void setExportFormFields(boolean value)
        
        Gets or sets indication of whether form fields are exported as interactive items (as 'input' tag) rather than converted to text or graphics.

        Example:

        Shows how to export form fields to Html.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.insertCheckBox("CheckBox", false, 15);
        
        // When we export a document with form fields to .html,
        // there are two ways in which Aspose.Words can export form fields.
        // Setting the "ExportFormFields" flag to "true" will export them as interactive objects.
        // Setting this flag to "false" will display form fields as plain text.
        // This will freeze them at their current value, and prevent the reader of our HTML document
        // from being able to interact with them.
        HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions();
        {
            htmlFixedSaveOptions.setExportFormFields(exportFormFields);
        }
        
        doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.ExportFormFields.html", htmlFixedSaveOptions);
      • getFontFormat/setFontFormat

        public int getFontFormat() / public void setFontFormat(int value)
        
        Gets or sets ExportFontFormat used for font exporting. Default value is ExportFontFormat.WOFF. The value of the property is ExportFontFormat integer constant.

        Example:

        Shows how use fonts only from the target machine when saving a document to HTML.
        Document doc = new Document(getMyDir() + "Bullet points with alternative font.docx");
        
        HtmlFixedSaveOptions saveOptions = new HtmlFixedSaveOptions();
        {
            saveOptions.setExportEmbeddedCss(true);
            saveOptions.setUseTargetMachineFonts(useTargetMachineFonts);
            saveOptions.setFontFormat(ExportFontFormat.TTF);
            saveOptions.setExportEmbeddedFonts(false);
        }
        
        doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.UsingMachineFonts.html", saveOptions);
      • getJpegQuality/setJpegQuality

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

        Has effect only when a document contains JPEG images.

        Use this property to get or set the quality of the images inside a document when saving in fixed page format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression.

        The default value is 95.

        Example:

        Shows how to configure compression while saving a document as a JPEG.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.insertImage(getImageDir() + "Logo.jpg");
        
        // Create an "ImageSaveOptions" object which we can pass to the document's "Save" method
        // to modify the way in which that method renders the document into an image.
        ImageSaveOptions imageOptions = new ImageSaveOptions(SaveFormat.JPEG);
        
        // Set the "JpegQuality" property to "10" to use stronger compression when rendering the document.
        // This will reduce the file size of the document, but the image will display more prominent compression artifacts.
        imageOptions.setJpegQuality(10);
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.JpegQuality.HighCompression.jpg", imageOptions);
        
        // Set the "JpegQuality" property to "100" to use weaker compression when rending the document.
        // This will improve the quality of the image, but will also increase the file size.
        imageOptions.setJpegQuality(100);
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.JpegQuality.HighQuality.jpg", imageOptions);
      • getMemoryOptimization/setMemoryOptimization

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

        Example:

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

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

        Example:

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

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

        Example:

        Shows how to set the numeral format used when saving to PDF.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getFont().setLocaleId(1025);
        builder.writeln("1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 50, 100");
        
        // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
        // to modify how that method converts the document to .PDF.
        PdfSaveOptions options = new PdfSaveOptions();
        
        // Set the "NumeralFormat" property to "NumeralFormat.ArabicIndic" to
        // use glyphs from the U+0660 to U+0669 range as numbers.
        // Set the "NumeralFormat" property to "NumeralFormat.Context" to
        // look up the locale to determine what number of glyphs to use.
        // Set the "NumeralFormat" property to "NumeralFormat.EasternArabicIndic" to
        // use glyphs from the U+06F0 to U+06F9 range as numbers.
        // Set the "NumeralFormat" property to "NumeralFormat.European" to use european numerals.
        // Set the "NumeralFormat" property to "NumeralFormat.System" to determine the symbol set from regional settings.
        options.setNumeralFormat(numeralFormat);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.SetNumeralFormat.pdf", options);
      • getOptimizeOutput/setOptimizeOutput

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

        Example:

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

        public int getPageHorizontalAlignment() / public void setPageHorizontalAlignment(int value)
        
        Specifies the horizontal alignment of pages in an HTML document. Default value is HtmlFixedHorizontalPageAlignment.Center. The value of the property is HtmlFixedPageHorizontalAlignment integer constant.

        Example:

        Shows how to set the horizontal alignment of pages when saving a document to HTML.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        
        HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions();
        {
            htmlFixedSaveOptions.setPageHorizontalAlignment(pageHorizontalAlignment);
        }
        
        doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.HorizontalAlignment.html", htmlFixedSaveOptions);
      • getPageMargins/setPageMargins

        public double getPageMargins() / public void setPageMargins(double value)
        
        Specifies the margins around pages in an HTML document. The margins value is measured in points and should be equal to or greater than 0. Default value is 10 points.

        Depends on the value of PageHorizontalAlignment property:

        Example:

        Shows how to adjust page margins when saving a document to HTML.
        Document doc = new Document(getMyDir() + "Document.docx");
        
        HtmlFixedSaveOptions saveOptions = new HtmlFixedSaveOptions();
        {
            saveOptions.setPageMargins(15.0);
        }
        
        doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.PageMargins.html", saveOptions);
      • getPageSavingCallback/setPageSavingCallback

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

        Example:

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

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

        Example:

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

        Example:

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

        Example:

        Shows how to convert only some of the pages in a document to PDF.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.writeln("Page 1.");
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.writeln("Page 2.");
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.writeln("Page 3.");
        
        // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
        // to modify how that method converts the document to .PDF.
        PdfSaveOptions options = new PdfSaveOptions();
        
            // Set the "PageIndex" to "1" to render a portion of the document starting from the second page.
        options.setPageSet(new PageSet(1));
        
        // This document will contain one page starting from page two, which will only contain the second page.
        doc.save(new FileOutputStream(getArtifactsDir() + "PdfSaveOptions.OnePage.pdf"), options);
      • 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);
      • getResourceSavingCallback/setResourceSavingCallback

        public IResourceSavingCallback getResourceSavingCallback() / public void setResourceSavingCallback(IResourceSavingCallback value)
        
        Allows to control how resources (images, fonts and css) are saved when a document is exported to fixed page Html format.

        Example:

        Shows how to use a callback to print the URIs of external resources created while converting a document to HTML.
        public void htmlFixedResourceFolder() throws Exception {
            Document doc = new Document(getMyDir() + "Rendering.docx");
        
            ResourceUriPrinter callback = new ResourceUriPrinter();
        
            HtmlFixedSaveOptions options = new HtmlFixedSaveOptions();
            {
                options.setSaveFormat(SaveFormat.HTML_FIXED);
                options.setExportEmbeddedImages(false);
                options.setResourcesFolder(getArtifactsDir() + "HtmlFixedResourceFolder");
                options.setResourcesFolderAlias(getArtifactsDir() + "HtmlFixedResourceFolderAlias");
                options.setShowPageBorder(false);
                options.setResourceSavingCallback(callback);
            }
        
            // A folder specified by ResourcesFolderAlias will contain the resources instead of ResourcesFolder.
            // We must ensure the folder exists before the streams can put their resources into it.
            new File(options.getResourcesFolderAlias()).mkdir();
        
            doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.HtmlFixedResourceFolder.html", options);
        
            System.out.println(callback.getText());
        
            String[] resourceFiles = new File(getArtifactsDir() + "HtmlFixedResourceFolderAlias").list();
        
            Assert.assertFalse(new File(getArtifactsDir() + "HtmlFixedResourceFolder").exists());
            Assert.assertEquals(6, IterableUtils.countMatches(Arrays.asList(resourceFiles),
                    f -> f.endsWith(".jpeg") || f.endsWith(".png") || f.endsWith(".css")));
        }
        
        /// <summary>
        /// Counts and prints URIs of resources contained by as they are converted to fixed .Html.
        /// </summary>
        private static class ResourceUriPrinter implements IResourceSavingCallback {
            public void resourceSaving(ResourceSavingArgs args) throws Exception {
                // If we set a folder alias in the SaveOptions object, we will be able to print it from here.
                mText.append(MessageFormat.format("Resource #{0} \"{1}\"", ++mSavedResourceCount, args.getResourceFileName()));
        
                String extension = FilenameUtils.getExtension(args.getResourceFileName());
                switch (extension) {
                    case "ttf":
                    case "woff": {
                        // By default, 'ResourceFileUri' uses system folder for fonts.
                        // To avoid problems in other platforms you must explicitly specify the path for the fonts.
                        args.setResourceFileUri(getArtifactsDir() + File.separatorChar + args.getResourceFileName());
                        break;
                    }
                }
        
                mText.append("\t" + args.getResourceFileUri());
        
                // If we have specified a folder in the "ResourcesFolderAlias" property,
                // we will also need to redirect each stream to put its resource in that folder.
                args.setResourceStream(new FileOutputStream(args.getResourceFileUri()));
                args.setKeepResourceStreamOpen(false);
            }
        
            public String getText() {
                return mText.toString();
            }
        
            private int mSavedResourceCount;
            private final /*final*/ StringBuilder mText = new StringBuilder();
        }
      • getResourcesFolder/setResourcesFolder

        public java.lang.String getResourcesFolder() / public void setResourcesFolder(java.lang.String value)
        
        Specifies the physical folder where resources (images, fonts, css) are saved when exporting a document to Html format. Default is null.

        Has effect only if ExportEmbeddedImages property is false.

        When you save a Document in Html format, Aspose.Words needs to save all images embedded in the document as standalone files. ResourcesFolder allows you to specify where the images will be saved and ResourcesFolderAlias 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 ResourcesFolder 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 by using the ResourcesFolder property

        Example:

        Shows how to use a callback to print the URIs of external resources created while converting a document to HTML.
        public void htmlFixedResourceFolder() throws Exception {
            Document doc = new Document(getMyDir() + "Rendering.docx");
        
            ResourceUriPrinter callback = new ResourceUriPrinter();
        
            HtmlFixedSaveOptions options = new HtmlFixedSaveOptions();
            {
                options.setSaveFormat(SaveFormat.HTML_FIXED);
                options.setExportEmbeddedImages(false);
                options.setResourcesFolder(getArtifactsDir() + "HtmlFixedResourceFolder");
                options.setResourcesFolderAlias(getArtifactsDir() + "HtmlFixedResourceFolderAlias");
                options.setShowPageBorder(false);
                options.setResourceSavingCallback(callback);
            }
        
            // A folder specified by ResourcesFolderAlias will contain the resources instead of ResourcesFolder.
            // We must ensure the folder exists before the streams can put their resources into it.
            new File(options.getResourcesFolderAlias()).mkdir();
        
            doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.HtmlFixedResourceFolder.html", options);
        
            System.out.println(callback.getText());
        
            String[] resourceFiles = new File(getArtifactsDir() + "HtmlFixedResourceFolderAlias").list();
        
            Assert.assertFalse(new File(getArtifactsDir() + "HtmlFixedResourceFolder").exists());
            Assert.assertEquals(6, IterableUtils.countMatches(Arrays.asList(resourceFiles),
                    f -> f.endsWith(".jpeg") || f.endsWith(".png") || f.endsWith(".css")));
        }
        
        /// <summary>
        /// Counts and prints URIs of resources contained by as they are converted to fixed .Html.
        /// </summary>
        private static class ResourceUriPrinter implements IResourceSavingCallback {
            public void resourceSaving(ResourceSavingArgs args) throws Exception {
                // If we set a folder alias in the SaveOptions object, we will be able to print it from here.
                mText.append(MessageFormat.format("Resource #{0} \"{1}\"", ++mSavedResourceCount, args.getResourceFileName()));
        
                String extension = FilenameUtils.getExtension(args.getResourceFileName());
                switch (extension) {
                    case "ttf":
                    case "woff": {
                        // By default, 'ResourceFileUri' uses system folder for fonts.
                        // To avoid problems in other platforms you must explicitly specify the path for the fonts.
                        args.setResourceFileUri(getArtifactsDir() + File.separatorChar + args.getResourceFileName());
                        break;
                    }
                }
        
                mText.append("\t" + args.getResourceFileUri());
        
                // If we have specified a folder in the "ResourcesFolderAlias" property,
                // we will also need to redirect each stream to put its resource in that folder.
                args.setResourceStream(new FileOutputStream(args.getResourceFileUri()));
                args.setKeepResourceStreamOpen(false);
            }
        
            public String getText() {
                return mText.toString();
            }
        
            private int mSavedResourceCount;
            private final /*final*/ StringBuilder mText = new StringBuilder();
        }
        See Also:
        ResourcesFolderAlias
      • getResourcesFolderAlias/setResourcesFolderAlias

        public java.lang.String getResourcesFolderAlias() / public void setResourcesFolderAlias(java.lang.String value)
        
        Specifies the name of the folder used to construct image URIs written into an Html document. Default is null.

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

        Example:

        Shows how to use a callback to print the URIs of external resources created while converting a document to HTML.
        public void htmlFixedResourceFolder() throws Exception {
            Document doc = new Document(getMyDir() + "Rendering.docx");
        
            ResourceUriPrinter callback = new ResourceUriPrinter();
        
            HtmlFixedSaveOptions options = new HtmlFixedSaveOptions();
            {
                options.setSaveFormat(SaveFormat.HTML_FIXED);
                options.setExportEmbeddedImages(false);
                options.setResourcesFolder(getArtifactsDir() + "HtmlFixedResourceFolder");
                options.setResourcesFolderAlias(getArtifactsDir() + "HtmlFixedResourceFolderAlias");
                options.setShowPageBorder(false);
                options.setResourceSavingCallback(callback);
            }
        
            // A folder specified by ResourcesFolderAlias will contain the resources instead of ResourcesFolder.
            // We must ensure the folder exists before the streams can put their resources into it.
            new File(options.getResourcesFolderAlias()).mkdir();
        
            doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.HtmlFixedResourceFolder.html", options);
        
            System.out.println(callback.getText());
        
            String[] resourceFiles = new File(getArtifactsDir() + "HtmlFixedResourceFolderAlias").list();
        
            Assert.assertFalse(new File(getArtifactsDir() + "HtmlFixedResourceFolder").exists());
            Assert.assertEquals(6, IterableUtils.countMatches(Arrays.asList(resourceFiles),
                    f -> f.endsWith(".jpeg") || f.endsWith(".png") || f.endsWith(".css")));
        }
        
        /// <summary>
        /// Counts and prints URIs of resources contained by as they are converted to fixed .Html.
        /// </summary>
        private static class ResourceUriPrinter implements IResourceSavingCallback {
            public void resourceSaving(ResourceSavingArgs args) throws Exception {
                // If we set a folder alias in the SaveOptions object, we will be able to print it from here.
                mText.append(MessageFormat.format("Resource #{0} \"{1}\"", ++mSavedResourceCount, args.getResourceFileName()));
        
                String extension = FilenameUtils.getExtension(args.getResourceFileName());
                switch (extension) {
                    case "ttf":
                    case "woff": {
                        // By default, 'ResourceFileUri' uses system folder for fonts.
                        // To avoid problems in other platforms you must explicitly specify the path for the fonts.
                        args.setResourceFileUri(getArtifactsDir() + File.separatorChar + args.getResourceFileName());
                        break;
                    }
                }
        
                mText.append("\t" + args.getResourceFileUri());
        
                // If we have specified a folder in the "ResourcesFolderAlias" property,
                // we will also need to redirect each stream to put its resource in that folder.
                args.setResourceStream(new FileOutputStream(args.getResourceFileUri()));
                args.setKeepResourceStreamOpen(false);
            }
        
            public String getText() {
                return mText.toString();
            }
        
            private int mSavedResourceCount;
            private final /*final*/ StringBuilder mText = new StringBuilder();
        }
        See Also:
        ResourcesFolder
      • getSaveFontFaceCssSeparately/setSaveFontFaceCssSeparately

        public boolean getSaveFontFaceCssSeparately() / public void setSaveFontFaceCssSeparately(boolean value)
        
        Flag indicates whether "@font-face" CSS rules should be placed into a separate file "fontFaces.css" when a document is being saved with external stylesheet (that is, when ExportEmbeddedCss is false). Default value is false, all CSS rules are written into single file "styles.css". Setting this property to true restores the old behavior (separate files) for compatibility with legacy code.

        Example:

        Shows how to place CSS into a separate file and add a prefix to all of its CSS class names.
        Document doc = new Document(getMyDir() + "Bookmarks.docx");
        
        HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions();
        {
            htmlFixedSaveOptions.setCssClassNamesPrefix("myprefix");
            htmlFixedSaveOptions.setSaveFontFaceCssSeparately(true);
        }
        
        doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.AddCssClassNamesPrefix.html", htmlFixedSaveOptions);
        
        String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlFixedSaveOptions.AddCssClassNamesPrefix.html"), "utf-8");
        
        Assert.assertTrue(outDocContents.contains("<div class=\"myprefixdiv myprefixpage\""));
      • getSaveFormat/setSaveFormat

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

        Example:

        Shows how to use a callback to print the URIs of external resources created while converting a document to HTML.
        public void htmlFixedResourceFolder() throws Exception {
            Document doc = new Document(getMyDir() + "Rendering.docx");
        
            ResourceUriPrinter callback = new ResourceUriPrinter();
        
            HtmlFixedSaveOptions options = new HtmlFixedSaveOptions();
            {
                options.setSaveFormat(SaveFormat.HTML_FIXED);
                options.setExportEmbeddedImages(false);
                options.setResourcesFolder(getArtifactsDir() + "HtmlFixedResourceFolder");
                options.setResourcesFolderAlias(getArtifactsDir() + "HtmlFixedResourceFolderAlias");
                options.setShowPageBorder(false);
                options.setResourceSavingCallback(callback);
            }
        
            // A folder specified by ResourcesFolderAlias will contain the resources instead of ResourcesFolder.
            // We must ensure the folder exists before the streams can put their resources into it.
            new File(options.getResourcesFolderAlias()).mkdir();
        
            doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.HtmlFixedResourceFolder.html", options);
        
            System.out.println(callback.getText());
        
            String[] resourceFiles = new File(getArtifactsDir() + "HtmlFixedResourceFolderAlias").list();
        
            Assert.assertFalse(new File(getArtifactsDir() + "HtmlFixedResourceFolder").exists());
            Assert.assertEquals(6, IterableUtils.countMatches(Arrays.asList(resourceFiles),
                    f -> f.endsWith(".jpeg") || f.endsWith(".png") || f.endsWith(".css")));
        }
        
        /// <summary>
        /// Counts and prints URIs of resources contained by as they are converted to fixed .Html.
        /// </summary>
        private static class ResourceUriPrinter implements IResourceSavingCallback {
            public void resourceSaving(ResourceSavingArgs args) throws Exception {
                // If we set a folder alias in the SaveOptions object, we will be able to print it from here.
                mText.append(MessageFormat.format("Resource #{0} \"{1}\"", ++mSavedResourceCount, args.getResourceFileName()));
        
                String extension = FilenameUtils.getExtension(args.getResourceFileName());
                switch (extension) {
                    case "ttf":
                    case "woff": {
                        // By default, 'ResourceFileUri' uses system folder for fonts.
                        // To avoid problems in other platforms you must explicitly specify the path for the fonts.
                        args.setResourceFileUri(getArtifactsDir() + File.separatorChar + args.getResourceFileName());
                        break;
                    }
                }
        
                mText.append("\t" + args.getResourceFileUri());
        
                // If we have specified a folder in the "ResourcesFolderAlias" property,
                // we will also need to redirect each stream to put its resource in that folder.
                args.setResourceStream(new FileOutputStream(args.getResourceFileUri()));
                args.setKeepResourceStreamOpen(false);
            }
        
            public String getText() {
                return mText.toString();
            }
        
            private int mSavedResourceCount;
            private final /*final*/ StringBuilder mText = new StringBuilder();
        }
      • getShowPageBorder/setShowPageBorder

        public boolean getShowPageBorder() / public void setShowPageBorder(boolean value)
        
        Specifies whether border around pages should be shown. Default is true.

        Example:

        Shows how to use a callback to print the URIs of external resources created while converting a document to HTML.
        public void htmlFixedResourceFolder() throws Exception {
            Document doc = new Document(getMyDir() + "Rendering.docx");
        
            ResourceUriPrinter callback = new ResourceUriPrinter();
        
            HtmlFixedSaveOptions options = new HtmlFixedSaveOptions();
            {
                options.setSaveFormat(SaveFormat.HTML_FIXED);
                options.setExportEmbeddedImages(false);
                options.setResourcesFolder(getArtifactsDir() + "HtmlFixedResourceFolder");
                options.setResourcesFolderAlias(getArtifactsDir() + "HtmlFixedResourceFolderAlias");
                options.setShowPageBorder(false);
                options.setResourceSavingCallback(callback);
            }
        
            // A folder specified by ResourcesFolderAlias will contain the resources instead of ResourcesFolder.
            // We must ensure the folder exists before the streams can put their resources into it.
            new File(options.getResourcesFolderAlias()).mkdir();
        
            doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.HtmlFixedResourceFolder.html", options);
        
            System.out.println(callback.getText());
        
            String[] resourceFiles = new File(getArtifactsDir() + "HtmlFixedResourceFolderAlias").list();
        
            Assert.assertFalse(new File(getArtifactsDir() + "HtmlFixedResourceFolder").exists());
            Assert.assertEquals(6, IterableUtils.countMatches(Arrays.asList(resourceFiles),
                    f -> f.endsWith(".jpeg") || f.endsWith(".png") || f.endsWith(".css")));
        }
        
        /// <summary>
        /// Counts and prints URIs of resources contained by as they are converted to fixed .Html.
        /// </summary>
        private static class ResourceUriPrinter implements IResourceSavingCallback {
            public void resourceSaving(ResourceSavingArgs args) throws Exception {
                // If we set a folder alias in the SaveOptions object, we will be able to print it from here.
                mText.append(MessageFormat.format("Resource #{0} \"{1}\"", ++mSavedResourceCount, args.getResourceFileName()));
        
                String extension = FilenameUtils.getExtension(args.getResourceFileName());
                switch (extension) {
                    case "ttf":
                    case "woff": {
                        // By default, 'ResourceFileUri' uses system folder for fonts.
                        // To avoid problems in other platforms you must explicitly specify the path for the fonts.
                        args.setResourceFileUri(getArtifactsDir() + File.separatorChar + args.getResourceFileName());
                        break;
                    }
                }
        
                mText.append("\t" + args.getResourceFileUri());
        
                // If we have specified a folder in the "ResourcesFolderAlias" property,
                // we will also need to redirect each stream to put its resource in that folder.
                args.setResourceStream(new FileOutputStream(args.getResourceFileUri()));
                args.setKeepResourceStreamOpen(false);
            }
        
            public String getText() {
                return mText.toString();
            }
        
            private int mSavedResourceCount;
            private final /*final*/ StringBuilder mText = new StringBuilder();
        }
      • getTempFolder/setTempFolder

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

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

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

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

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

        Example:

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

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

        Example:

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

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

        Example:

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

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

        Example:

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

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

        Example:

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

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

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

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

        Example:

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

        public boolean getUseTargetMachineFonts() / public void setUseTargetMachineFonts(boolean value)
        
        Flag indicates whether fonts from target machine must be used to display the document. If this flag is set to true, FontFormat and ExportEmbeddedFonts properties do not have effect, also ResourceSavingCallback is not fired for fonts. Default is false.

        Example:

        Shows how use fonts only from the target machine when saving a document to HTML.
        Document doc = new Document(getMyDir() + "Bullet points with alternative font.docx");
        
        HtmlFixedSaveOptions saveOptions = new HtmlFixedSaveOptions();
        {
            saveOptions.setExportEmbeddedCss(true);
            saveOptions.setUseTargetMachineFonts(useTargetMachineFonts);
            saveOptions.setFontFormat(ExportFontFormat.TTF);
            saveOptions.setExportEmbeddedFonts(false);
        }
        
        doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.UsingMachineFonts.html", saveOptions);
    • Method Detail

      • equals

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