com.aspose.words
Class HtmlFixedSaveOptions

java.lang.Object
  extended by SaveOptions
      extended by com.aspose.words.HtmlFixedSaveOptions

public class HtmlFixedSaveOptions 
extends SaveOptions

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

Constructor Summary
HtmlFixedSaveOptions()
           Initializes a new instance of this class that can be used to save a document in the SaveFormat.HTML_FIXED format.
 
Property Getters/Setters Summary
intgetColorMode()→ inherited from SaveOptions
voidsetColorMode(int value)
           Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant.
java.lang.StringgetCssClassNamesPrefix()
voidsetCssClassNamesPrefix(java.lang.String value)
           Specifies prefix which is added to all class names in style.css file. Default value is "aw".
intgetDmlEffectsRenderingMode()→ inherited from SaveOptions
voidsetDmlEffectsRenderingMode(int value)
           Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant.
intgetDmlRenderingMode()→ inherited from SaveOptions
voidsetDmlRenderingMode(int value)
           Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant.
booleangetExportEmbeddedCss()
voidsetExportEmbeddedCss(boolean value)
           Specifies whether the CSS (Cascading Style Sheet) should be embedded into Html document.
booleangetExportEmbeddedFonts()
voidsetExportEmbeddedFonts(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.
booleangetExportEmbeddedImages()
voidsetExportEmbeddedImages(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.
booleangetExportEmbeddedSvg()
voidsetExportEmbeddedSvg(boolean value)
           Specifies whether SVG resources should be embedded into Html document. Default value is true.
intgetFontFormat()
voidsetFontFormat(int value)
           Gets or sets ExportFontFormat used for font exporting. Default value is ExportFontFormat.WOFF. The value of the property is ExportFontFormat integer constant.
intgetJpegQuality()
voidsetJpegQuality(int value)
           Gets or sets a value determining the quality of the JPEG images inside Html document.
MetafileRenderingOptionsgetMetafileRenderingOptions()
           Allows to specify metafile rendering options.
intgetNumeralFormat()
voidsetNumeralFormat(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.
intgetPageCount()
voidsetPageCount(int value)
           Gets or sets the number of pages to save. Default is java.lang.Integer.MAX_VALUE which means all pages of the document will be rendered.
intgetPageHorizontalAlignment()
voidsetPageHorizontalAlignment(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.
intgetPageIndex()
voidsetPageIndex(int value)
           Gets or sets the 0-based index of the first page to save. Default is 0.
doublegetPageMargins()
voidsetPageMargins(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.
booleangetPrettyFormat()→ inherited from SaveOptions
voidsetPrettyFormat(boolean value)
           When true, pretty formats output where applicable. Default value is false.
IResourceSavingCallbackgetResourceSavingCallback()
voidsetResourceSavingCallback(IResourceSavingCallback value)
           Allows to control how resources (images, fonts and css) are saved when a document is exported to fixed page Html format.
java.lang.StringgetResourcesFolder()
voidsetResourcesFolder(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.
java.lang.StringgetResourcesFolderAlias()
voidsetResourcesFolderAlias(java.lang.String value)
           Specifies the name of the folder used to construct image URIs written into an Html document. Default is null.
intgetSaveFormat()
voidsetSaveFormat(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.
booleangetShowPageBorder()
voidsetShowPageBorder(boolean value)
           Specifies whether border around pages should be shown. Default is true.
java.lang.StringgetTempFolder()→ inherited from SaveOptions
voidsetTempFolder(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.
booleangetUpdateSdtContent()→ inherited from SaveOptions
voidsetUpdateSdtContent(boolean value)
           Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
booleangetUseAntiAliasing()→ inherited from SaveOptions
voidsetUseAntiAliasing(boolean value)
           Gets or sets a value determining whether or not to use anti-aliasing for rendering.
booleangetUseHighQualityRendering()→ inherited from SaveOptions
voidsetUseHighQualityRendering(boolean value)
           Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
IWarningCallbackgetWarningCallback()→ inherited from SaveOptions
voidsetWarningCallback(IWarningCallback value)
           Called during a save operation, when an issue is detected that might result in data or formatting fidelity loss.
 

Constructor Detail

HtmlFixedSaveOptions

public HtmlFixedSaveOptions()
Initializes a new instance of this class that can be used to save a document in the SaveFormat.HTML_FIXED format.

Property Getters/Setters Detail

getColorMode/setColorMode

→ inherited from SaveOptions
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

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


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

getDmlEffectsRenderingMode/setDmlEffectsRenderingMode

→ inherited from SaveOptions
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

→ inherited from SaveOptions
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.


getExportEmbeddedCss/setExportEmbeddedCss

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

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.

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.

getExportEmbeddedSvg/setExportEmbeddedSvg

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

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.

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


getMetafileRenderingOptions

public MetafileRenderingOptions getMetafileRenderingOptions()
Allows to specify metafile rendering options.

getNumeralFormat/setNumeralFormat

public int getNumeralFormat() / public void setNumeralFormat(int value)
Gets or sets NumeralFormat used for rendering of numerals. European numerals are used by default. The value of the property is NumeralFormat integer constant.

getPageCount/setPageCount

public int getPageCount() / public void setPageCount(int value)
Gets or sets the number of pages to save. Default is java.lang.Integer.MAX_VALUE which means all pages of the document will be rendered.

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.

getPageIndex/setPageIndex

public int getPageIndex() / public void setPageIndex(int value)
Gets or sets the 0-based index of the first page to save. Default is 0.

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:


getPrettyFormat/setPrettyFormat

→ inherited from SaveOptions
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 pass an option to export HTML tags in a well spaced, human readable format.
Document doc = new Document(getMyDir() + "Document.doc");

HtmlSaveOptions htmlOptions = new HtmlSaveOptions(SaveFormat.HTML);
// Enabling the PrettyFormat setting will export HTML in an indented format that is easy to read.
// If this is setting is false (by default) then the HTML tags will be exported in condensed form with no indentation.
htmlOptions.setPrettyFormat(true);

doc.save(getMyDir() + "Document.PrettyFormat Out.html", htmlOptions);

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.

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

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.

See Also:
ResourcesFolder

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.

getShowPageBorder/setShowPageBorder

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

getTempFolder/setTempFolder

→ inherited from SaveOptions
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.


getUpdateSdtContent/setUpdateSdtContent

→ inherited from SaveOptions
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.

getUseAntiAliasing/setUseAntiAliasing

→ inherited from SaveOptions
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. When the document is exported to the SaveFormat.HTML, SaveFormat.MHTML and SaveFormat.EPUB formats this option is used for raster images.


getUseHighQualityRendering/setUseHighQualityRendering

→ inherited from SaveOptions
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.


getWarningCallback/setWarningCallback

→ inherited from SaveOptions
public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)
Called during a save operation, when an issue is detected that might result in data or formatting fidelity loss.

This property is obsolete. Please use DocumentBase.WarningCallback instead.

Example:

Demonstrates how to implement the IWarningCallback to be notified of any font substitution during document save.
public class HandleDocumentWarnings implements IWarningCallback
{
    /**
     * Our callback only needs to implement the "Warning" method. This method is called whenever there is a
     * potential issue during document procssing. The callback can be set to listen for warnings generated during document
     * load and/or document save.
     */
    public void warning(WarningInfo info)
    {
        // We are only interested in fonts being substituted.
        if (info.getWarningType() == WarningType.FONT_SUBSTITUTION)
        {
            System.out.println("Font substitution: " + info.getDescription());
        }
    }

}

Example:

Demonstrates how to recieve notifications of font substitutions by using IWarningCallback.
// Load the document to render.
Document doc = new Document(getMyDir() + "Document.doc");

// We can choose the default font to use in the case of any missing fonts.
FontSettings.setDefaultFontName("Arial");

// For testing we will set Aspose.Words to look for fonts only in a folder which doesn't exist. Since Aspose.Words won't
// find any fonts in the specified directory, then during rendering the fonts in the document will be subsuited with the default
// font specified under FontSettings.DefaultFontName. We can pick up on this subsuition using our callback.
FontSettings.setFontsFolder("", false);

// Create a new class implementing IWarningCallback which collect any warnings produced during document save.
HandleDocumentWarnings callback = new HandleDocumentWarnings();

// We assign the callback to the appropriate save options class. In this case, we are going to save to PDF
// so we create a PdfSaveOptions class and assign the callback there.
PdfSaveOptions saveOptions = new PdfSaveOptions();
saveOptions.setWarningCallback(callback);

// Pass the save options along with the save path to the save method.
doc.save(getMyDir() + "Rendering.MissingFontNotification Out.pdf", saveOptions);

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.