com.aspose.words

Class HtmlFixedSaveOptions

java.lang.Object

com.aspose.words.SaveOptions

com.aspose.words.FixedPageSaveOptions

com.aspose.words.HtmlFixedSaveOptions

public class HtmlFixedSaveOptions
extends FixedPageSaveOptions

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

To learn more, visit the Specify Save Options documentation article.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCssClassNamesPrefix() Specifies prefix which is added to all class names in style.css file.
java.nio.charset.Charset	getEncoding()
boolean	getExportEmbeddedCss() Specifies whether the CSS (Cascading Style Sheet) should be embedded into Html document.
boolean	getExportEmbeddedFonts() Specifies whether fonts should be embedded into Html document in Base64 format.
boolean	getExportEmbeddedImages() Specifies whether images should be embedded into Html document in Base64 format.
boolean	getExportEmbeddedSvg() Specifies whether SVG resources should be embedded into Html document.
boolean	getExportFormFields() Gets indication of whether form fields are exported as interactive items (as 'input' tag) rather than converted to text or graphics.
int	getFontFormat() Gets ExportFontFormat used for font exporting.
boolean	getOptimizeOutput() Flag indicates whether it is required to optimize output.
int	getPageHorizontalAlignment() Specifies the horizontal alignment of pages in an HTML document.
double	getPageMargins() Specifies the margins around pages in an HTML document.
IResourceSavingCallback	getResourceSavingCallback() Allows to control how resources (images, fonts and css) are saved when a document is exported to fixed page Html format.
java.lang.String	getResourcesFolder() Specifies the physical folder where resources (images, fonts, css) are saved when exporting a document to Html format.
java.lang.String	getResourcesFolderAlias() Specifies the name of the folder used to construct image URIs written into an Html document.
boolean	getSaveFontFaceCssSeparately() 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 getExportEmbeddedCss() / setExportEmbeddedCss(boolean) is false).
int	getSaveFormat() Specifies the format in which the document will be saved if this save options object is used.
boolean	getShowPageBorder() Specifies whether border around pages should be shown.
boolean	getUseTargetMachineFonts() Flag indicates whether fonts from target machine must be used to display the document.
void	setCssClassNamesPrefix(java.lang.String value) Specifies prefix which is added to all class names in style.css file.
void	setEncoding(java.nio.charset.Charset value)
void	setExportEmbeddedCss(boolean value) Specifies whether the CSS (Cascading Style Sheet) should be embedded into Html document.
void	setExportEmbeddedFonts(boolean value) Specifies whether fonts should be embedded into Html document in Base64 format.
void	setExportEmbeddedImages(boolean value) Specifies whether images should be embedded into Html document in Base64 format.
void	setExportEmbeddedSvg(boolean value) Specifies whether SVG resources should be embedded into Html document.
void	setExportFormFields(boolean value) Sets indication of whether form fields are exported as interactive items (as 'input' tag) rather than converted to text or graphics.
void	setFontFormat(int value) Sets ExportFontFormat used for font exporting.
void	setOptimizeOutput(boolean value) Flag indicates whether it is required to optimize output.
void	setPageHorizontalAlignment(int value) Specifies the horizontal alignment of pages in an HTML document.
void	setPageMargins(double value) Specifies the margins around pages in an HTML document.
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.
void	setResourcesFolder(java.lang.String value) Specifies the physical folder where resources (images, fonts, css) are saved when exporting a document to Html format.
void	setResourcesFolderAlias(java.lang.String value) Specifies the name of the folder used to construct image URIs written into an Html document.
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 getExportEmbeddedCss() / setExportEmbeddedCss(boolean) is false).
void	setSaveFormat(int value) Specifies the format in which the document will be saved if this save options object is used.
void	setShowPageBorder(boolean value) Specifies whether border around pages should be shown.
void	setUseTargetMachineFonts(boolean value) Flag indicates whether fonts from target machine must be used to display the document.

Methods inherited from class com.aspose.words.FixedPageSaveOptions

equals, getColorMode, getJpegQuality, getMetafileRenderingOptions, getNumeralFormat, getPageSavingCallback, getPageSet, setColorMode, setJpegQuality, setMetafileRenderingOptions, setNumeralFormat, setPageSavingCallback, setPageSet

Methods inherited from class com.aspose.words.SaveOptions

createSaveOptions, createSaveOptions, getAllowEmbeddingPostScriptFonts, getDefaultTemplate, getDml3DEffectsRenderingMode, getDmlEffectsRenderingMode, getDmlRenderingMode, getExportGeneratorName, getImlRenderingMode, getMemoryOptimization, getPrettyFormat, getProgressCallback, getTempFolder, getUpdateCreatedTimeProperty, getUpdateFields, getUpdateLastPrintedProperty, getUpdateLastSavedTimeProperty, getUpdateSdtContent, getUseAntiAliasing, getUseHighQualityRendering, setAllowEmbeddingPostScriptFonts, setDefaultTemplate, setDml3DEffectsRenderingMode, setDmlEffectsRenderingMode, setDmlRenderingMode, setExportGeneratorName, setImlRenderingMode, setMemoryOptimization, setPrettyFormat, setProgressCallback, setTempFolder, setUpdateCreatedTimeProperty, setUpdateFields, setUpdateLastPrintedProperty, setUpdateLastSavedTimeProperty, setUpdateSdtContent, setUseAntiAliasing, setUseHighQualityRendering

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSaveFormat

public int getSaveFormat()

Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.HTML_FIXED.

Specified by:

getSaveFormat in class SaveOptions

Returns:

The corresponding int value. The returned value is one of SaveFormat constants.

setSaveFormat

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.

Specified by:

setSaveFormat in class SaveOptions

Parameters:

value - The corresponding int value. The value must be one of SaveFormat constants.

getShowPageBorder

public boolean getShowPageBorder()

Specifies whether border around pages should be shown. Default is true.

Returns:

The corresponding boolean value.

setShowPageBorder

public void setShowPageBorder(boolean value)

Specifies whether border around pages should be shown. Default is true.

Parameters:

value - The corresponding boolean value.

getPageHorizontalAlignment

public int getPageHorizontalAlignment()

Specifies the horizontal alignment of pages in an HTML document. Default value is HtmlFixedHorizontalPageAlignment.Center.

Returns:

The corresponding int value. The returned value is one of HtmlFixedPageHorizontalAlignment constants.

setPageHorizontalAlignment

public void setPageHorizontalAlignment(int value)

Specifies the horizontal alignment of pages in an HTML document. Default value is HtmlFixedHorizontalPageAlignment.Center.

Parameters:

value - The corresponding int value. The value must be one of HtmlFixedPageHorizontalAlignment constants.

getPageMargins

public double getPageMargins()

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 getPageHorizontalAlignment() / setPageHorizontalAlignment(int) property:

• Defines top, bottom and left page margins if the value is HtmlFixedPageHorizontalAlignment.LEFT.
• Defines top, bottom and right page margins if the value is HtmlFixedPageHorizontalAlignment.RIGHT.
• Defines top and bottom page margins if the value is HtmlFixedPageHorizontalAlignment.CENTER.

Returns:

The corresponding double value.

setPageMargins

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 getPageHorizontalAlignment() / setPageHorizontalAlignment(int) property:

• Defines top, bottom and left page margins if the value is HtmlFixedPageHorizontalAlignment.LEFT.
• Defines top, bottom and right page margins if the value is HtmlFixedPageHorizontalAlignment.RIGHT.
• Defines top and bottom page margins if the value is HtmlFixedPageHorizontalAlignment.CENTER.

Parameters:

value - The corresponding double value.

getResourcesFolder

public java.lang.String getResourcesFolder()

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 getExportEmbeddedImages() / setExportEmbeddedImages(boolean) 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. getResourcesFolder() / setResourcesFolder(java.lang.String) allows you to specify where the images will be saved and getResourcesFolderAlias() / setResourcesFolderAlias(java.lang.String) 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 getResourcesFolder() / setResourcesFolder(java.lang.String) 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 getResourcesFolder() / setResourcesFolder(java.lang.String) property

Returns:

The corresponding String value.

See Also:

getResourcesFolderAlias(), setResourcesFolderAlias(java.lang.String)

setResourcesFolder

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 getExportEmbeddedImages() / setExportEmbeddedImages(boolean) 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. getResourcesFolder() / setResourcesFolder(java.lang.String) allows you to specify where the images will be saved and getResourcesFolderAlias() / setResourcesFolderAlias(java.lang.String) 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 getResourcesFolder() / setResourcesFolder(java.lang.String) 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 getResourcesFolder() / setResourcesFolder(java.lang.String) property

Parameters:

value - The corresponding String value.

See Also:

getResourcesFolderAlias(), setResourcesFolderAlias(java.lang.String)

getResourcesFolderAlias

public java.lang.String getResourcesFolderAlias()

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. getResourcesFolder() / setResourcesFolder(java.lang.String) allows you to specify where the images will be saved and getResourcesFolderAlias() / setResourcesFolderAlias(java.lang.String) allows to specify how the image URIs will be constructed.

Returns:

The corresponding String value.

See Also:

getResourcesFolder(), setResourcesFolder(java.lang.String)

setResourcesFolderAlias

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. getResourcesFolder() / setResourcesFolder(java.lang.String) allows you to specify where the images will be saved and getResourcesFolderAlias() / setResourcesFolderAlias(java.lang.String) allows to specify how the image URIs will be constructed.

Parameters:

value - The corresponding String value.

See Also:

getResourcesFolder(), setResourcesFolder(java.lang.String)

getExportEmbeddedImages

public boolean getExportEmbeddedImages()

Specifies whether images should be embedded into Html document in Base64 format. Note setting this flag can significantly increase size of output Html file.

Returns:

The corresponding boolean value.

setExportEmbeddedImages

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.

Parameters:

value - The corresponding boolean value.

getExportEmbeddedFonts

public boolean getExportEmbeddedFonts()

Specifies whether fonts should be embedded into Html document in Base64 format. Note setting this flag can significantly increase size of output Html file.

Returns:

The corresponding boolean value.

setExportEmbeddedFonts

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.

Parameters:

value - The corresponding boolean value.

getExportEmbeddedCss

public boolean getExportEmbeddedCss()

Specifies whether the CSS (Cascading Style Sheet) should be embedded into Html document.

Returns:

The corresponding boolean value.

setExportEmbeddedCss

public void setExportEmbeddedCss(boolean value)

Specifies whether the CSS (Cascading Style Sheet) should be embedded into Html document.

Parameters:

value - The corresponding boolean value.

getExportEmbeddedSvg

public boolean getExportEmbeddedSvg()

Specifies whether SVG resources should be embedded into Html document. Default value is true.

Returns:

The corresponding boolean value.

setExportEmbeddedSvg

public void setExportEmbeddedSvg(boolean value)

Specifies whether SVG resources should be embedded into Html document. Default value is true.

Parameters:

value - The corresponding boolean value.

getFontFormat

public int getFontFormat()

Gets ExportFontFormat used for font exporting. Default value is ExportFontFormat.WOFF.

Returns:

ExportFontFormat used for font exporting. The returned value is one of ExportFontFormat constants.

setFontFormat

public void setFontFormat(int value)

Sets ExportFontFormat used for font exporting. Default value is ExportFontFormat.WOFF.

Parameters:

value - ExportFontFormat used for font exporting. The value must be one of ExportFontFormat constants.

getCssClassNamesPrefix

public java.lang.String getCssClassNamesPrefix()

Specifies prefix which is added to all class names in style.css file. Default value is "aw".

Returns:

The corresponding String value.

setCssClassNamesPrefix

public void setCssClassNamesPrefix(java.lang.String value)

Specifies prefix which is added to all class names in style.css file. Default value is "aw".

Parameters:

value - The corresponding String value.

getResourceSavingCallback

public IResourceSavingCallback getResourceSavingCallback()

Allows to control how resources (images, fonts and css) are saved when a document is exported to fixed page Html format.

Returns:

The corresponding IResourceSavingCallback value.

setResourceSavingCallback

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.

Parameters:

value - The corresponding IResourceSavingCallback value.

getEncoding

public java.nio.charset.Charset getEncoding()

setEncoding

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

getExportFormFields

public boolean getExportFormFields()

Gets indication of whether form fields are exported as interactive items (as 'input' tag) rather than converted to text or graphics.

Returns:

Indication of whether form fields are exported as interactive items (as 'input' tag) rather than converted to text or graphics.

setExportFormFields

public void setExportFormFields(boolean value)

Sets indication of whether form fields are exported as interactive items (as 'input' tag) rather than converted to text or graphics.

Parameters:

value - Indication of whether form fields are exported as interactive items (as 'input' tag) rather than converted to text or graphics.

getOptimizeOutput

public boolean getOptimizeOutput()

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.

Overrides:

getOptimizeOutput in class FixedPageSaveOptions

Returns:

The corresponding boolean value.

setOptimizeOutput

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.

Overrides:

setOptimizeOutput in class FixedPageSaveOptions

Parameters:

value - The corresponding boolean value.

getUseTargetMachineFonts

public boolean getUseTargetMachineFonts()

Flag indicates whether fonts from target machine must be used to display the document. If this flag is set to true, getFontFormat() / setFontFormat(int) and getExportEmbeddedFonts() / setExportEmbeddedFonts(boolean) properties do not have effect, also getResourceSavingCallback() / setResourceSavingCallback(com.aspose.words.IResourceSavingCallback) is not fired for fonts. Default is false.

Returns:

The corresponding boolean value.

setUseTargetMachineFonts

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, getFontFormat() / setFontFormat(int) and getExportEmbeddedFonts() / setExportEmbeddedFonts(boolean) properties do not have effect, also getResourceSavingCallback() / setResourceSavingCallback(com.aspose.words.IResourceSavingCallback) is not fired for fonts. Default is false.

Parameters:

value - The corresponding boolean value.

getSaveFontFaceCssSeparately

public boolean getSaveFontFaceCssSeparately()

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 getExportEmbeddedCss() / setExportEmbeddedCss(boolean) 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.

Returns:

The corresponding boolean value.

setSaveFontFaceCssSeparately

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 getExportEmbeddedCss() / setExportEmbeddedCss(boolean) 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.

Parameters:

value - The corresponding boolean value.