HtmlSaveOptions

Inheritance: java.lang.Object, com.aspose.words.SaveOptions

All Implemented Interfaces: java.lang.Cloneable

public class HtmlSaveOptions extends SaveOptions implements Cloneable

Can be used to specify additional options when saving a document into the SaveFormat.HTML, SaveFormat.MHTML, SaveFormat.EPUB or SaveFormat.AZW_3 format.

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

Constructors

Constructor Description
HtmlSaveOptions() Initializes a new instance of this class that can be used to save a document in the SaveFormat.HTML format.
HtmlSaveOptions(int saveFormat) Initializes a new instance of this class.

Methods

Method Description
createSaveOptions(int saveFormat)
createSaveOptions(String fileName) Creates a save options object of a class suitable for the file extension specified in the given file name.
equals(Object arg0)
getAllowEmbeddingPostScriptFonts() Gets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved.
getAllowNegativeIndent() Specifies whether negative left and right indents of paragraphs are normalized when saving to HTML, MHTML or EPUB.
getClass()
getCssClassNamePrefix() Specifies a prefix which is added to all CSS class names.
getCssSavingCallback() Allows to control how CSS styles are saved when a document is saved to HTML, MHTML or EPUB.
getCssStyleSheetFileName() Specifies the path and the name of the Cascading Style Sheet (CSS) file written when a document is exported to HTML.
getCssStyleSheetType() Specifies how CSS (Cascading Style Sheet) styles are exported to HTML, MHTML or EPUB.
getDefaultTemplate() Gets path to default template (including filename).
getDml3DEffectsRenderingMode() Gets a value determining how 3D effects are rendered.
getDmlEffectsRenderingMode() Gets a value determining how DrawingML effects are rendered.
getDmlRenderingMode() Gets a value determining how DrawingML shapes are rendered.
getDocumentPartSavingCallback() Allows to control how document parts are saved when a document is saved to HTML or EPUB.
getDocumentSplitCriteria() Specifies how the document should be split when saving to SaveFormat.HTML, SaveFormat.EPUB or SaveFormat.AZW_3 format.
getDocumentSplitHeadingLevel() Specifies the maximum level of headings at which to split the document.
getEncoding()
getEpubNavigationMapLevel() Specifies the maximum level of headings populated to the navigation map when exporting to IDPF EPUB or AZW3 formats.
getExportCidUrlsForMhtmlResources() Specifies whether to use CID (Content-ID) URLs to reference resources (images, fonts, CSS) included in MHTML documents.
getExportDocumentProperties() Specifies whether to export built-in and custom document properties to HTML, MHTML or EPUB.
getExportDropDownFormFieldAsText() Controls how drop-down form fields are saved to HTML or MHTML.
getExportFontResources() Specifies whether font resources should be exported to HTML, MHTML or EPUB.
getExportFontsAsBase64() Specifies whether fonts resources should be embedded to HTML in Base64 encoding.
getExportGeneratorName() When true , causes the name and version of Aspose.Words to be embedded into produced files.
getExportHeadersFootersMode() Specifies how headers and footers are output to HTML, MHTML or EPUB.
getExportImagesAsBase64() Specifies whether images are saved in Base64 format to the output HTML, MHTML or EPUB.
getExportLanguageInformation() Specifies whether language information is exported to HTML, MHTML or EPUB.
getExportListLabels() Controls how list labels are output to HTML, MHTML or EPUB.
getExportOriginalUrlForLinkedImages() Specifies whether original URL should be used as the URL of the linked images.
getExportPageMargins() Specifies whether page margins is exported to HTML, MHTML or EPUB.
getExportPageSetup() Specifies whether page setup is exported to HTML, MHTML or EPUB.
getExportRelativeFontSize() Specifies whether font sizes should be output in relative units when saving to HTML, MHTML or EPUB.
getExportRoundtripInformation() Specifies whether to write the roundtrip information when saving to HTML, MHTML or EPUB.
getExportShapesAsSvg() Controls whether Shape nodes are converted to SVG images when saving to HTML, MHTML, EPUB or AZW3.
getExportTextInputFormFieldAsText() Controls how text input form fields are saved to HTML or MHTML.
getExportTocPageNumbers() Specifies whether to write page numbers to table of contents when saving HTML, MHTML and EPUB.
getExportXhtmlTransitional() Specifies whether to write the DOCTYPE declaration when saving to HTML or MHTML.
getFontResourcesSubsettingSizeThreshold() Controls which font resources need subsetting when saving to HTML, MHTML or EPUB.
getFontSavingCallback() Allows to control how fonts are saved when a document is saved to HTML, MHTML or EPUB.
getFontsFolder() Specifies the physical folder where fonts are saved when exporting a document to HTML.
getFontsFolderAlias() Specifies the name of the folder used to construct font URIs written into an HTML document.
getHtmlVersion() Specifies version of HTML standard that should be used when saving the document to HTML or MHTML.
getImageResolution() Specifies the output resolution for images when exporting to HTML, MHTML or EPUB.
getImageSavingCallback() Allows to control how images are saved when a document is saved to HTML, MHTML or EPUB.
getImagesFolder() Specifies the physical folder where images are saved when exporting a document to HTML format.
getImagesFolderAlias() Specifies the name of the folder used to construct image URIs written into an HTML document.
getImlRenderingMode() Gets a value determining how ink (InkML) objects are rendered.
getMemoryOptimization() Gets value determining if memory optimization should be performed before saving the document.
getMetafileFormat() Specifies in what format metafiles are saved when exporting to HTML, MHTML, or EPUB.
getOfficeMathOutputMode() Controls how OfficeMath objects are exported to HTML, MHTML or EPUB.
getPrettyFormat() When true , pretty formats output where applicable.
getProgressCallback() Called during saving a document and accepts data about saving progress.
getResolveFontNames() Specifies whether font family names used in the document are resolved and substituted according to Document.getFontSettings() / Document.setFontSettings(com.aspose.words.FontSettings) when being written into HTML-based formats.
getResourceFolder() Specifies a physical folder where all resources like images, fonts, and external CSS are saved when a document is exported to HTML.
getResourceFolderAlias() Specifies the name of the folder used to construct URIs of all resources written into an HTML document.
getSaveFormat() Specifies the format in which the document will be saved if this save options object is used.
getScaleImageToShapeSize() Specifies whether images are scaled by Aspose.Words to the bounding shape size when exporting to HTML, MHTML or EPUB.
getTableWidthOutputMode() Controls how table, row and cell widths are exported to HTML, MHTML or EPUB.
getTempFolder() Specifies the folder for temporary files used when saving to a DOC or DOCX file.
getUpdateCreatedTimeProperty() Gets a value determining whether the BuiltInDocumentProperties.getCreatedTime() / BuiltInDocumentProperties.setCreatedTime(java.util.Date) property is updated before saving.
getUpdateFields() Gets a value determining if fields of certain types should be updated before saving the document to a fixed page format.
getUpdateLastPrintedProperty() Gets a value determining whether the BuiltInDocumentProperties.getLastPrinted() / BuiltInDocumentProperties.setLastPrinted(java.util.Date) property is updated before saving.
getUpdateLastSavedTimeProperty() Gets a value determining whether the BuiltInDocumentProperties.getLastSavedTime() / BuiltInDocumentProperties.setLastSavedTime(java.util.Date) property is updated before saving.
getUpdateSdtContent() Gets value determining whether content of StructuredDocumentTag is updated before saving.
getUseAntiAliasing() Gets a value determining whether or not to use anti-aliasing for rendering.
getUseHighQualityRendering() Gets a value determining whether or not to use high quality (i.e.
hashCode()
notify()
notifyAll()
setAllowEmbeddingPostScriptFonts(boolean value) Sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved.
setAllowNegativeIndent(boolean value) Specifies whether negative left and right indents of paragraphs are normalized when saving to HTML, MHTML or EPUB.
setCssClassNamePrefix(String value) Specifies a prefix which is added to all CSS class names.
setCssSavingCallback(ICssSavingCallback value) Allows to control how CSS styles are saved when a document is saved to HTML, MHTML or EPUB.
setCssStyleSheetFileName(String value) Specifies the path and the name of the Cascading Style Sheet (CSS) file written when a document is exported to HTML.
setCssStyleSheetType(int value) Specifies how CSS (Cascading Style Sheet) styles are exported to HTML, MHTML or EPUB.
setDefaultTemplate(String value) Sets path to default template (including filename).
setDml3DEffectsRenderingMode(int value) Sets a value determining how 3D effects are rendered.
setDmlEffectsRenderingMode(int value) Sets a value determining how DrawingML effects are rendered.
setDmlRenderingMode(int value) Sets a value determining how DrawingML shapes are rendered.
setDocumentPartSavingCallback(IDocumentPartSavingCallback value) Allows to control how document parts are saved when a document is saved to HTML or EPUB.
setDocumentSplitCriteria(int value) Specifies how the document should be split when saving to SaveFormat.HTML, SaveFormat.EPUB or SaveFormat.AZW_3 format.
setDocumentSplitHeadingLevel(int value) Specifies the maximum level of headings at which to split the document.
setEncoding(Charset value)
setEpubNavigationMapLevel(int value) Specifies the maximum level of headings populated to the navigation map when exporting to IDPF EPUB or AZW3 formats.
setExportCidUrlsForMhtmlResources(boolean value) Specifies whether to use CID (Content-ID) URLs to reference resources (images, fonts, CSS) included in MHTML documents.
setExportDocumentProperties(boolean value) Specifies whether to export built-in and custom document properties to HTML, MHTML or EPUB.
setExportDropDownFormFieldAsText(boolean value) Controls how drop-down form fields are saved to HTML or MHTML.
setExportFontResources(boolean value) Specifies whether font resources should be exported to HTML, MHTML or EPUB.
setExportFontsAsBase64(boolean value) Specifies whether fonts resources should be embedded to HTML in Base64 encoding.
setExportGeneratorName(boolean value) When true , causes the name and version of Aspose.Words to be embedded into produced files.
setExportHeadersFootersMode(int value) Specifies how headers and footers are output to HTML, MHTML or EPUB.
setExportImagesAsBase64(boolean value) Specifies whether images are saved in Base64 format to the output HTML, MHTML or EPUB.
setExportLanguageInformation(boolean value) Specifies whether language information is exported to HTML, MHTML or EPUB.
setExportListLabels(int value) Controls how list labels are output to HTML, MHTML or EPUB.
setExportOriginalUrlForLinkedImages(boolean value) Specifies whether original URL should be used as the URL of the linked images.
setExportPageMargins(boolean value) Specifies whether page margins is exported to HTML, MHTML or EPUB.
setExportPageSetup(boolean value) Specifies whether page setup is exported to HTML, MHTML or EPUB.
setExportRelativeFontSize(boolean value) Specifies whether font sizes should be output in relative units when saving to HTML, MHTML or EPUB.
setExportRoundtripInformation(boolean value) Specifies whether to write the roundtrip information when saving to HTML, MHTML or EPUB.
setExportShapesAsSvg(boolean value) Controls whether Shape nodes are converted to SVG images when saving to HTML, MHTML, EPUB or AZW3.
setExportTextInputFormFieldAsText(boolean value) Controls how text input form fields are saved to HTML or MHTML.
setExportTocPageNumbers(boolean value) Specifies whether to write page numbers to table of contents when saving HTML, MHTML and EPUB.
setExportXhtmlTransitional(boolean value) Specifies whether to write the DOCTYPE declaration when saving to HTML or MHTML.
setFontResourcesSubsettingSizeThreshold(int value) Controls which font resources need subsetting when saving to HTML, MHTML or EPUB.
setFontSavingCallback(IFontSavingCallback value) Allows to control how fonts are saved when a document is saved to HTML, MHTML or EPUB.
setFontsFolder(String value) Specifies the physical folder where fonts are saved when exporting a document to HTML.
setFontsFolderAlias(String value) Specifies the name of the folder used to construct font URIs written into an HTML document.
setHtmlVersion(int value) Specifies version of HTML standard that should be used when saving the document to HTML or MHTML.
setImageResolution(int value) Specifies the output resolution for images when exporting to HTML, MHTML or EPUB.
setImageSavingCallback(IImageSavingCallback value) Allows to control how images are saved when a document is saved to HTML, MHTML or EPUB.
setImagesFolder(String value) Specifies the physical folder where images are saved when exporting a document to HTML format.
setImagesFolderAlias(String value) Specifies the name of the folder used to construct image URIs written into an HTML document.
setImlRenderingMode(int value) Sets a value determining how ink (InkML) objects are rendered.
setMemoryOptimization(boolean value) Sets value determining if memory optimization should be performed before saving the document.
setMetafileFormat(int value) Specifies in what format metafiles are saved when exporting to HTML, MHTML, or EPUB.
setOfficeMathOutputMode(int value) Controls how OfficeMath objects are exported to HTML, MHTML or EPUB.
setPrettyFormat(boolean value) When true , pretty formats output where applicable.
setProgressCallback(IDocumentSavingCallback value) Called during saving a document and accepts data about saving progress.
setResolveFontNames(boolean value) Specifies whether font family names used in the document are resolved and substituted according to Document.getFontSettings() / Document.setFontSettings(com.aspose.words.FontSettings) when being written into HTML-based formats.
setResourceFolder(String value) Specifies a physical folder where all resources like images, fonts, and external CSS are saved when a document is exported to HTML.
setResourceFolderAlias(String value) Specifies the name of the folder used to construct URIs of all resources written into an HTML document.
setSaveFormat(int value) Specifies the format in which the document will be saved if this save options object is used.
setScaleImageToShapeSize(boolean value) Specifies whether images are scaled by Aspose.Words to the bounding shape size when exporting to HTML, MHTML or EPUB.
setTableWidthOutputMode(int value) Controls how table, row and cell widths are exported to HTML, MHTML or EPUB.
setTempFolder(String value) Specifies the folder for temporary files used when saving to a DOC or DOCX file.
setUpdateCreatedTimeProperty(boolean value) Sets a value determining whether the BuiltInDocumentProperties.getCreatedTime() / BuiltInDocumentProperties.setCreatedTime(java.util.Date) property is updated before saving.
setUpdateFields(boolean value) Sets a value determining if fields of certain types should be updated before saving the document to a fixed page format.
setUpdateLastPrintedProperty(boolean value) Sets a value determining whether the BuiltInDocumentProperties.getLastPrinted() / BuiltInDocumentProperties.setLastPrinted(java.util.Date) property is updated before saving.
setUpdateLastSavedTimeProperty(boolean value) Sets a value determining whether the BuiltInDocumentProperties.getLastSavedTime() / BuiltInDocumentProperties.setLastSavedTime(java.util.Date) property is updated before saving.
setUpdateSdtContent(boolean value) Sets value determining whether content of StructuredDocumentTag is updated before saving.
setUseAntiAliasing(boolean value) Sets a value determining whether or not to use anti-aliasing for rendering.
setUseHighQualityRendering(boolean value) Sets a value determining whether or not to use high quality (i.e.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

HtmlSaveOptions()

public HtmlSaveOptions()

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

HtmlSaveOptions(int saveFormat)

public HtmlSaveOptions(int saveFormat)

Initializes a new instance of this class.

Parameters:

Parameter Type Description
saveFormat int

createSaveOptions(int saveFormat)

public static SaveOptions createSaveOptions(int saveFormat)

Parameters:

Parameter Type Description
saveFormat int

Returns: SaveOptions

createSaveOptions(String fileName)

public static SaveOptions createSaveOptions(String fileName)

Creates a save options object of a class suitable for the file extension specified in the given file name.

Parameters:

Parameter Type Description
fileName java.lang.String The extension of this file name determines the class of the save options object to create.

Returns: SaveOptions - An object of a class that derives from SaveOptions.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter Type Description
arg0 java.lang.Object

Returns: boolean

getAllowEmbeddingPostScriptFonts()

public boolean getAllowEmbeddingPostScriptFonts()

Gets 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.getEmbedTrueTypeFonts() / FontInfoCollection.setEmbedTrueTypeFonts(boolean) of the DocumentBase.getFontInfos() property is set to true .

Returns: boolean - A boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved.

getAllowNegativeIndent()

public boolean getAllowNegativeIndent()

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

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

Returns: boolean - The corresponding boolean value.

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCssClassNamePrefix()

public String getCssClassNamePrefix()

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

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

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

Returns: java.lang.String - The corresponding java.lang.String value.

getCssSavingCallback()

public ICssSavingCallback getCssSavingCallback()

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

Returns: ICssSavingCallback - The corresponding ICssSavingCallback value.

getCssStyleSheetFileName()

public String getCssStyleSheetFileName()

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

This property has effect only when saving a document to HTML format and external CSS style sheet is requested using getCssStyleSheetType() / setCssStyleSheetType(int).

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

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

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

Another way to specify a folder where external CSS file is saved is to use getResourceFolder() / setResourceFolder(java.lang.String).

Returns: java.lang.String - The corresponding java.lang.String value.

getCssStyleSheetType()

public int getCssStyleSheetType()

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

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

Returns: int - The corresponding int value. The returned value is one of CssStyleSheetType constants.

getDefaultTemplate()

public String getDefaultTemplate()

Gets 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.getAutomaticallyUpdateStyles() / Document.setAutomaticallyUpdateStyles(boolean) is true , but Document.getAttachedTemplate() / Document.setAttachedTemplate(java.lang.String) is empty.

Returns: java.lang.String - Path to default template (including filename).

getDml3DEffectsRenderingMode()

public int getDml3DEffectsRenderingMode()

Gets a value determining how 3D effects are rendered. The default value is Dml3DEffectsRenderingMode.BASIC.

Returns: int - A value determining how 3D effects are rendered. The returned value is one of Dml3DEffectsRenderingMode constants.

getDmlEffectsRenderingMode()

public int getDmlEffectsRenderingMode()

Gets a value determining how DrawingML effects are rendered. The default value is DmlEffectsRenderingMode.SIMPLIFIED.

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

Returns: int - A value determining how DrawingML effects are rendered. The returned value is one of DmlEffectsRenderingMode constants.

getDmlRenderingMode()

public int getDmlRenderingMode()

Gets a value determining how DrawingML shapes are rendered. The default value is DmlRenderingMode.FALLBACK.

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

Returns: int - A value determining how DrawingML shapes are rendered. The returned value is one of DmlRenderingMode constants.

getDocumentPartSavingCallback()

public IDocumentPartSavingCallback getDocumentPartSavingCallback()

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

Returns: IDocumentPartSavingCallback - The corresponding IDocumentPartSavingCallback value.

getDocumentSplitCriteria()

public int getDocumentSplitCriteria()

Specifies how the document should be split when saving to SaveFormat.HTML, SaveFormat.EPUB or SaveFormat.AZW_3 format. Default is DocumentSplitCriteria.NONE for HTML and DocumentSplitCriteria.HEADING_PARAGRAPH for EPUB and AZW3.

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

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

Returns: int - The corresponding int value. The returned value is a bitwise combination of DocumentSplitCriteria constants.

getDocumentSplitHeadingLevel()

public int getDocumentSplitHeadingLevel()

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

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

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

Returns: int - The corresponding int value.

getEncoding()

public Charset getEncoding()

Returns: java.nio.charset.Charset

getEpubNavigationMapLevel()

public int getEpubNavigationMapLevel()

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

Navigation map in IDPF EPUB or AZW3 formats allows user agents to provide easy way of navigation through the document structure. Usually navigation points correspond to headings in the document. To populate headings up to level N assign this value to getEpubNavigationMapLevel() / setEpubNavigationMapLevel(int).

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

Returns: int - The corresponding int value.

getExportCidUrlsForMhtmlResources()

public boolean getExportCidUrlsForMhtmlResources()

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

This option affects only documents being saved to MHTML.

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

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

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

Returns: boolean - The corresponding boolean value.

getExportDocumentProperties()

public boolean getExportDocumentProperties()

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

Returns: boolean - The corresponding boolean value.

getExportDropDownFormFieldAsText()

public boolean getExportDropDownFormFieldAsText()

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

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

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

Returns: boolean - The corresponding boolean value.

getExportFontResources()

public boolean getExportFontResources()

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

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

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

If getExportFontsAsBase64() / setExportFontsAsBase64(boolean) is set to true , fonts will not be saved to separate files. Instead, they will be embedded into @font-face at-rules in Base64 encoding.

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

Returns: boolean - The corresponding boolean value.

getExportFontsAsBase64()

public boolean getExportFontsAsBase64()

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

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

Returns: boolean - The corresponding boolean value.

getExportGeneratorName()

public boolean getExportGeneratorName()

When true , causes the name and version of Aspose.Words to be embedded into produced files. Default value is true .

Returns: boolean - The corresponding boolean value.

getExportHeadersFootersMode()

public int getExportHeadersFootersMode()

Specifies how headers and footers are output to HTML, MHTML or EPUB. Default value is ExportHeadersFootersMode.PER_SECTION for HTML/MHTML and ExportHeadersFootersMode.NONE for EPUB.

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

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

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

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

Returns: int - The corresponding int value. The returned value is one of ExportHeadersFootersMode constants.

getExportImagesAsBase64()

public boolean getExportImagesAsBase64()

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

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

Returns: boolean - The corresponding boolean value.

getExportLanguageInformation()

public boolean getExportLanguageInformation()

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

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

Returns: boolean - The corresponding boolean value.

getExportListLabels()

public int getExportListLabels()

Controls how list labels are output to HTML, MHTML or EPUB. Default value is ExportListLabels.AUTO.

Returns: int - The corresponding int value. The returned value is one of ExportListLabels constants.

getExportOriginalUrlForLinkedImages()

public boolean getExportOriginalUrlForLinkedImages()

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

If value is set to true ImageData.getSourceFullName() / ImageData.setSourceFullName(java.lang.String) value is used as the URL of linked images and linked images are not loaded into document’s folder or getImagesFolder() / setImagesFolder(java.lang.String).

If value is set to false linked images are loaded into document’s folder or getImagesFolder() / setImagesFolder(java.lang.String) and URL of each linked image is constructed depending on document’s folder, getImagesFolder() / setImagesFolder(java.lang.String) and getImagesFolderAlias() / setImagesFolderAlias(java.lang.String) properties.

Returns: boolean - The corresponding boolean value.

getExportPageMargins()

public boolean getExportPageMargins()

Specifies whether page margins is exported to HTML, MHTML or EPUB. Default is false . Aspose.Words does not show area of page margins by default. If any elements are completely or partially clipped by the document edge the displayed area can be extended with this option.

Returns: boolean - The corresponding boolean value.

getExportPageSetup()

public boolean getExportPageSetup()

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

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

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

Returns: boolean - The corresponding boolean value.

getExportRelativeFontSize()

public boolean getExportRelativeFontSize()

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

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

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

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

Returns: boolean - The corresponding boolean value.

getExportRoundtripInformation()

public boolean getExportRoundtripInformation()

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

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

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

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

Returns: boolean - The corresponding boolean value.

getExportShapesAsSvg()

public boolean getExportShapesAsSvg()

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

If this option is set to true , Shape nodes are exported as elements. Otherwise, they are rendered to bitmaps and are exported as ![Image 1][] elements.

[Image 1]:

Returns: boolean - The corresponding boolean value.

getExportTextInputFormFieldAsText()

public boolean getExportTextInputFormFieldAsText()

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

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

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

Returns: boolean - The corresponding boolean value.

getExportTocPageNumbers()

public boolean getExportTocPageNumbers()

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

Returns: boolean - The corresponding boolean value.

getExportXhtmlTransitional()

public boolean getExportXhtmlTransitional()

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

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

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


 
 
 
 

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

Returns: boolean - The corresponding boolean value.

getFontResourcesSubsettingSizeThreshold()

public int getFontResourcesSubsettingSizeThreshold()

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

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

Font subsetting works as follows:

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

Returns: int - The corresponding int value.

getFontSavingCallback()

public IFontSavingCallback getFontSavingCallback()

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

Returns: IFontSavingCallback - The corresponding IFontSavingCallback value.

getFontsFolder()

public String getFontsFolder()

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

When you save a Document in HTML format and getExportFontResources() / setExportFontResources(boolean) is set to true , Aspose.Words needs to save fonts used in the document as standalone files. getFontsFolder() / setFontsFolder(java.lang.String) allows you to specify where the fonts will be saved and getFontsFolderAlias() / setFontsFolderAlias(java.lang.String) allows to specify how the font URIs will be constructed.

If you save a document into a file and provide a file name, Aspose.Words, by default, saves the fonts in the same folder where the document file is saved. Use getFontsFolder() / setFontsFolder(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 fonts, but still needs to save the fonts somewhere. In this case, you need to specify an accessible folder in the getFontsFolder() / setFontsFolder(java.lang.String) property or provide custom streams via the getFontSavingCallback() / setFontSavingCallback(com.aspose.words.IFontSavingCallback) event handler.

If the folder specified by getFontsFolder() / setFontsFolder(java.lang.String) doesn’t exist, it will be created automatically.

getResourceFolder() / setResourceFolder(java.lang.String) is another way to specify a folder where fonts should be saved.

Returns: java.lang.String - The corresponding java.lang.String value.

getFontsFolderAlias()

public String getFontsFolderAlias()

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

When you save a Document in HTML format and getExportFontResources() / setExportFontResources(boolean) is set to true , Aspose.Words needs to save fonts used in the document as standalone files. getFontsFolder() / setFontsFolder(java.lang.String) allows you to specify where the fonts will be saved and getFontsFolderAlias() / setFontsFolderAlias(java.lang.String) allows to specify how the font URIs will be constructed.

If getFontsFolderAlias() / setFontsFolderAlias(java.lang.String) is not an empty string, then the font URI written to HTML will be FontsFolderAlias + .

If getFontsFolderAlias() / setFontsFolderAlias(java.lang.String) is an empty string, then the font URI written to HTML will be FontsFolder + .

If getFontsFolderAlias() / setFontsFolderAlias(java.lang.String) is set to ‘.’ (dot), then the font file name will be written to HTML without path regardless of other options.

Alternative way to specify the name of the folder to construct font URIs is to use getResourceFolderAlias() / setResourceFolderAlias(java.lang.String).

Returns: java.lang.String - The corresponding java.lang.String value.

getHtmlVersion()

public int getHtmlVersion()

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

Returns: int - The corresponding int value. The returned value is one of HtmlVersion constants.

getImageResolution()

public int getImageResolution()

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

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

Returns: int - The corresponding int value.

getImageSavingCallback()

public IImageSavingCallback getImageSavingCallback()

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

Returns: IImageSavingCallback - The corresponding IImageSavingCallback value.

getImagesFolder()

public String getImagesFolder()

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

When you save a Document in HTML format, Aspose.Words needs to save all images embedded in the document as standalone files. getImagesFolder() / setImagesFolder(java.lang.String) allows you to specify where the images will be saved and getImagesFolderAlias() / setImagesFolderAlias(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 getImagesFolder() / setImagesFolder(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 in the getImagesFolder() / setImagesFolder(java.lang.String) property or provide custom streams via the getImageSavingCallback() / setImageSavingCallback(com.aspose.words.IImageSavingCallback) event handler.

If the folder specified by getImagesFolder() / setImagesFolder(java.lang.String) doesn’t exist, it will be created automatically.

getResourceFolder() / setResourceFolder(java.lang.String) is another way to specify a folder where images should be saved.

Returns: java.lang.String - The corresponding java.lang.String value.

getImagesFolderAlias()

public String getImagesFolderAlias()

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

When you save a Document in HTML format, Aspose.Words needs to save all images embedded in the document as standalone files. getImagesFolder() / setImagesFolder(java.lang.String) allows you to specify where the images will be saved and getImagesFolderAlias() / setImagesFolderAlias(java.lang.String) allows to specify how the image URIs will be constructed.

If getImagesFolderAlias() / setImagesFolderAlias(java.lang.String) is not an empty string, then the image URI written to HTML will be ImagesFolderAlias + ![Image 1][].

If getImagesFolderAlias() / setImagesFolderAlias(java.lang.String) is an empty string, then the image URI written to HTML will be ImagesFolder + ![Image 1][].

If getImagesFolderAlias() / setImagesFolderAlias(java.lang.String) is set to ‘.’ (dot), then the image file name will be written to HTML without path regardless of other options.

Alternative way to specify the name of the folder to construct image URIs is to use getResourceFolderAlias() / setResourceFolderAlias(java.lang.String).

[Image 1]:

Returns: java.lang.String - The corresponding java.lang.String value.

getImlRenderingMode()

public int getImlRenderingMode()

Gets a value determining how ink (InkML) objects are rendered. The default value is ImlRenderingMode.INK_ML.

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

Returns: int - A value determining how ink (InkML) objects are rendered. The returned value is one of ImlRenderingMode constants.

getMemoryOptimization()

public boolean getMemoryOptimization()

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

Returns: boolean - Value determining if memory optimization should be performed before saving the document.

getMetafileFormat()

public int getMetafileFormat()

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

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

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

Returns: int - The corresponding int value. The returned value is one of HtmlMetafileFormat constants.

getOfficeMathOutputMode()

public int getOfficeMathOutputMode()

Controls how OfficeMath objects are exported to HTML, MHTML or EPUB. Default value is HtmlOfficeMathOutputMode.IMAGE.

Returns: int - The corresponding int value. The returned value is one of HtmlOfficeMathOutputMode constants.

getPrettyFormat()

public boolean getPrettyFormat()

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.

Returns: boolean - The corresponding boolean value.

getProgressCallback()

public IDocumentSavingCallback getProgressCallback()

Called during saving a document and accepts data about saving progress.

Progress is reported when saving to SaveFormat.DOCX, SaveFormat.FLAT_OPC, SaveFormat.DOCM, SaveFormat.DOTM, SaveFormat.DOTX, SaveFormat.HTML, SaveFormat.MHTML, SaveFormat.EPUB, SaveFormat.XAML_FLOW, or SaveFormat.XAML_FLOW_PACK.

Returns: IDocumentSavingCallback - The corresponding IDocumentSavingCallback value.

getResolveFontNames()

public boolean getResolveFontNames()

Specifies whether font family names used in the document are resolved and substituted according to Document.getFontSettings() / Document.setFontSettings(com.aspose.words.FontSettings) when being written into HTML-based formats.

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

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

Returns: boolean - The corresponding boolean value.

getResourceFolder()

public String getResourceFolder()

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

getResourceFolder() / setResourceFolder(java.lang.String) is the simplest way to specify a folder where all resources should be written. Another way is to use individual properties getFontsFolder() / setFontsFolder(java.lang.String), getImagesFolder() / setImagesFolder(java.lang.String), and getCssStyleSheetFileName() / setCssStyleSheetFileName(java.lang.String).

getResourceFolder() / setResourceFolder(java.lang.String) has a lower priority than folders specified via getFontsFolder() / setFontsFolder(java.lang.String), getImagesFolder() / setImagesFolder(java.lang.String), and getCssStyleSheetFileName() / setCssStyleSheetFileName(java.lang.String). For example, if both getResourceFolder() / setResourceFolder(java.lang.String) and getFontsFolder() / setFontsFolder(java.lang.String) are specified, fonts will be saved to getFontsFolder() / setFontsFolder(java.lang.String), while images and CSS will be saved to getResourceFolder() / setResourceFolder(java.lang.String).

If the folder specified by getResourceFolder() / setResourceFolder(java.lang.String) doesn’t exist, it will be created automatically.

Returns: java.lang.String - The corresponding java.lang.String value.

getResourceFolderAlias()

public String getResourceFolderAlias()

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

getResourceFolderAlias() / setResourceFolderAlias(java.lang.String) is the simplest way to specify how URIs for all resource files should be constructed. Same information can be specified for images and fonts separately via getImagesFolderAlias() / setImagesFolderAlias(java.lang.String) and getFontsFolderAlias() / setFontsFolderAlias(java.lang.String) properties, respectively. However, there is no individual property for CSS.

getResourceFolderAlias() / setResourceFolderAlias(java.lang.String) has lower priority than getFontsFolderAlias() / setFontsFolderAlias(java.lang.String) and getImagesFolderAlias() / setImagesFolderAlias(java.lang.String). For example, if both getResourceFolderAlias() / setResourceFolderAlias(java.lang.String) and getFontsFolderAlias() / setFontsFolderAlias(java.lang.String) are specified, fonts’ URIs will be constructed using getFontsFolderAlias() / setFontsFolderAlias(java.lang.String), while URIs of images and CSS will be constructed using getResourceFolderAlias() / setResourceFolderAlias(java.lang.String).

If getResourceFolderAlias() / setResourceFolderAlias(java.lang.String) is empty, the getResourceFolder() / setResourceFolder(java.lang.String) property value will be used to construct resource URIs.

If getResourceFolderAlias() / setResourceFolderAlias(java.lang.String) is set to ‘.’ (dot), resource URIs will contain file names only, without any path.

Returns: java.lang.String - The corresponding java.lang.String value.

getSaveFormat()

public int getSaveFormat()

Specifies the format in which the document will be saved if this save options object is used. Can be SaveFormat.HTML, SaveFormat.MHTML, SaveFormat.EPUB or SaveFormat.AZW_3.

Returns: int - The corresponding int value. The returned value is one of SaveFormat constants.

getScaleImageToShapeSize()

public boolean getScaleImageToShapeSize()

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

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

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

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

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

In addition to shapes containing individual raster images, this option also affects group shapes consisting of raster images. If getScaleImageToShapeSize() / setScaleImageToShapeSize(boolean) is false and a group shape contains raster images whose intrinsic resolution is higher than the value specified in getImageResolution() / setImageResolution(int), Aspose.Words will increase rendering resolution for that group. This allows to better preserve quality of grouped high resolution images when saving to HTML.

Returns: boolean - The corresponding boolean value.

getTableWidthOutputMode()

public int getTableWidthOutputMode()

Controls how table, row and cell widths are exported to HTML, MHTML or EPUB. Default value is HtmlElementSizeOutputMode.ALL.

In the HTML format, table, row and cell elements (

| -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ,  | ) can have their widths specified either in relative (percentage) or in absolute units. In a document in Aspose.Words, tables, rows and cells can have their widths specified using either relative or absolute units too.
 
 When you convert a document to HTML using Aspose.Words, you might want to control how table, row and cell widths are exported to affect how the resulting document is displayed in the visual agent (e.g. a browser or viewer).
 
 Use this property as a filter to specify what table widths values are exported into the destination document. For example, if you are converting a document to EPUB and intend to view the document on a mobile reading device, then you probably want to avoid exporting absolute width values. To do this you need to specify the output mode [HtmlElementSizeOutputMode.RELATIVE\_ONLY](../../com.aspose.words/htmlelementsizeoutputmode\#RELATIVE-ONLY) or [HtmlElementSizeOutputMode.NONE](../../com.aspose.words/htmlelementsizeoutputmode\#NONE) so the viewer on the mobile device can layout the table to fit the width of the screen as best as it can. |

Returns: int - The corresponding int value. The returned value is one of HtmlElementSizeOutputMode constants.

getTempFolder()

public String getTempFolder()

Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is null and no temporary files are used.

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

If you are saving a very large document (thousands of pages) and/or processing many documents at the same time, then the memory spike during saving can be significant enough to cause the system to throw java.lang.IndexOutOfBoundsException. Specifying a temporary folder using getTempFolder() / setTempFolder(java.lang.String) 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.

Returns: java.lang.String - The corresponding java.lang.String value.

getUpdateCreatedTimeProperty()

public boolean getUpdateCreatedTimeProperty()

Gets a value determining whether the BuiltInDocumentProperties.getCreatedTime() / BuiltInDocumentProperties.setCreatedTime(java.util.Date) property is updated before saving. Default value is false ;

Returns: boolean - A value determining whether the BuiltInDocumentProperties.getCreatedTime() / BuiltInDocumentProperties.setCreatedTime(java.util.Date) property is updated before saving.

getUpdateFields()

public boolean getUpdateFields()

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

Returns: boolean - A value determining if fields of certain types should be updated before saving the document to a fixed page format.

getUpdateLastPrintedProperty()

public boolean getUpdateLastPrintedProperty()

Gets a value determining whether the BuiltInDocumentProperties.getLastPrinted() / BuiltInDocumentProperties.setLastPrinted(java.util.Date) property is updated before saving.

Returns: boolean - A value determining whether the BuiltInDocumentProperties.getLastPrinted() / BuiltInDocumentProperties.setLastPrinted(java.util.Date) property is updated before saving.

getUpdateLastSavedTimeProperty()

public boolean getUpdateLastSavedTimeProperty()

Gets a value determining whether the BuiltInDocumentProperties.getLastSavedTime() / BuiltInDocumentProperties.setLastSavedTime(java.util.Date) property is updated before saving.

Returns: boolean - A value determining whether the BuiltInDocumentProperties.getLastSavedTime() / BuiltInDocumentProperties.setLastSavedTime(java.util.Date) property is updated before saving.

getUpdateSdtContent()

public boolean getUpdateSdtContent()

Gets value determining whether content of StructuredDocumentTag is updated before saving. The default value is false .

Returns: boolean - Value determining whether content of StructuredDocumentTag is updated before saving.

getUseAntiAliasing()

public boolean getUseAntiAliasing()

Gets a value determining whether or not to use anti-aliasing for rendering.

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

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

Returns: boolean - A value determining whether or not to use anti-aliasing for rendering.

getUseHighQualityRendering()

public boolean getUseHighQualityRendering()

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

Returns: boolean - A value determining whether or not to use high quality (i.e.

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setAllowEmbeddingPostScriptFonts(boolean value)

public void setAllowEmbeddingPostScriptFonts(boolean value)

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.getEmbedTrueTypeFonts() / FontInfoCollection.setEmbedTrueTypeFonts(boolean) of the DocumentBase.getFontInfos() property is set to true .

Parameters:

Parameter Type Description
value boolean A boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved.

setAllowNegativeIndent(boolean value)

public void setAllowNegativeIndent(boolean value)

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

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

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setCssClassNamePrefix(String value)

public void setCssClassNamePrefix(String value)

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

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

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

Parameters:

Parameter Type Description
value java.lang.String The corresponding java.lang.String value.

setCssSavingCallback(ICssSavingCallback value)

public void setCssSavingCallback(ICssSavingCallback value)

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

Parameters:

Parameter Type Description
value ICssSavingCallback The corresponding ICssSavingCallback value.

setCssStyleSheetFileName(String value)

public void setCssStyleSheetFileName(String value)

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

This property has effect only when saving a document to HTML format and external CSS style sheet is requested using getCssStyleSheetType() / setCssStyleSheetType(int).

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

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

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

Another way to specify a folder where external CSS file is saved is to use getResourceFolder() / setResourceFolder(java.lang.String).

Parameters:

Parameter Type Description
value java.lang.String The corresponding java.lang.String value.

setCssStyleSheetType(int value)

public void setCssStyleSheetType(int value)

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

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

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of CssStyleSheetType constants.

setDefaultTemplate(String value)

public void setDefaultTemplate(String value)

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.getAutomaticallyUpdateStyles() / Document.setAutomaticallyUpdateStyles(boolean) is true , but Document.getAttachedTemplate() / Document.setAttachedTemplate(java.lang.String) is empty.

Parameters:

Parameter Type Description
value java.lang.String Path to default template (including filename).

setDml3DEffectsRenderingMode(int value)

public void setDml3DEffectsRenderingMode(int value)

Sets a value determining how 3D effects are rendered. The default value is Dml3DEffectsRenderingMode.BASIC.

Parameters:

Parameter Type Description
value int A value determining how 3D effects are rendered. The value must be one of Dml3DEffectsRenderingMode constants.

setDmlEffectsRenderingMode(int value)

public void setDmlEffectsRenderingMode(int value)

Sets a value determining how DrawingML effects are rendered. The default value is DmlEffectsRenderingMode.SIMPLIFIED.

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

Parameters:

Parameter Type Description
value int A value determining how DrawingML effects are rendered. The value must be one of DmlEffectsRenderingMode constants.

setDmlRenderingMode(int value)

public void setDmlRenderingMode(int value)

Sets a value determining how DrawingML shapes are rendered. The default value is DmlRenderingMode.FALLBACK.

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

Parameters:

Parameter Type Description
value int A value determining how DrawingML shapes are rendered. The value must be one of DmlRenderingMode constants.

setDocumentPartSavingCallback(IDocumentPartSavingCallback value)

public void setDocumentPartSavingCallback(IDocumentPartSavingCallback value)

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

Parameters:

Parameter Type Description
value IDocumentPartSavingCallback The corresponding IDocumentPartSavingCallback value.

setDocumentSplitCriteria(int value)

public void setDocumentSplitCriteria(int value)

Specifies how the document should be split when saving to SaveFormat.HTML, SaveFormat.EPUB or SaveFormat.AZW_3 format. Default is DocumentSplitCriteria.NONE for HTML and DocumentSplitCriteria.HEADING_PARAGRAPH for EPUB and AZW3.

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

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

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be a bitwise combination of DocumentSplitCriteria constants.

setDocumentSplitHeadingLevel(int value)

public void setDocumentSplitHeadingLevel(int value)

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

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

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

Parameters:

Parameter Type Description
value int The corresponding int value.

setEncoding(Charset value)

public void setEncoding(Charset value)

Parameters:

Parameter Type Description
value java.nio.charset.Charset

setEpubNavigationMapLevel(int value)

public void setEpubNavigationMapLevel(int value)

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

Navigation map in IDPF EPUB or AZW3 formats allows user agents to provide easy way of navigation through the document structure. Usually navigation points correspond to headings in the document. To populate headings up to level N assign this value to getEpubNavigationMapLevel() / setEpubNavigationMapLevel(int).

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

Parameters:

Parameter Type Description
value int The corresponding int value.

setExportCidUrlsForMhtmlResources(boolean value)

public void setExportCidUrlsForMhtmlResources(boolean value)

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

This option affects only documents being saved to MHTML.

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

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

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

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setExportDocumentProperties(boolean value)

public void setExportDocumentProperties(boolean value)

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

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setExportDropDownFormFieldAsText(boolean value)

public void setExportDropDownFormFieldAsText(boolean value)

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

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

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

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setExportFontResources(boolean value)

public void setExportFontResources(boolean value)

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

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

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

If getExportFontsAsBase64() / setExportFontsAsBase64(boolean) is set to true , fonts will not be saved to separate files. Instead, they will be embedded into @font-face at-rules in Base64 encoding.

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

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setExportFontsAsBase64(boolean value)

public void setExportFontsAsBase64(boolean value)

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

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

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setExportGeneratorName(boolean value)

public void setExportGeneratorName(boolean value)

When true , causes the name and version of Aspose.Words to be embedded into produced files. Default value is true .

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setExportHeadersFootersMode(int value)

public void setExportHeadersFootersMode(int value)

Specifies how headers and footers are output to HTML, MHTML or EPUB. Default value is ExportHeadersFootersMode.PER_SECTION for HTML/MHTML and ExportHeadersFootersMode.NONE for EPUB.

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

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

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

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

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of ExportHeadersFootersMode constants.

setExportImagesAsBase64(boolean value)

public void setExportImagesAsBase64(boolean value)

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

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

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setExportLanguageInformation(boolean value)

public void setExportLanguageInformation(boolean value)

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

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

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setExportListLabels(int value)

public void setExportListLabels(int value)

Controls how list labels are output to HTML, MHTML or EPUB. Default value is ExportListLabels.AUTO.

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of ExportListLabels constants.

setExportOriginalUrlForLinkedImages(boolean value)

public void setExportOriginalUrlForLinkedImages(boolean value)

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

If value is set to true ImageData.getSourceFullName() / ImageData.setSourceFullName(java.lang.String) value is used as the URL of linked images and linked images are not loaded into document’s folder or getImagesFolder() / setImagesFolder(java.lang.String).

If value is set to false linked images are loaded into document’s folder or getImagesFolder() / setImagesFolder(java.lang.String) and URL of each linked image is constructed depending on document’s folder, getImagesFolder() / setImagesFolder(java.lang.String) and getImagesFolderAlias() / setImagesFolderAlias(java.lang.String) properties.

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setExportPageMargins(boolean value)

public void setExportPageMargins(boolean value)

Specifies whether page margins is exported to HTML, MHTML or EPUB. Default is false . Aspose.Words does not show area of page margins by default. If any elements are completely or partially clipped by the document edge the displayed area can be extended with this option.

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setExportPageSetup(boolean value)

public void setExportPageSetup(boolean value)

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

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

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

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setExportRelativeFontSize(boolean value)

public void setExportRelativeFontSize(boolean value)

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

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

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

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

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setExportRoundtripInformation(boolean value)

public void setExportRoundtripInformation(boolean value)

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

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

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

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

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setExportShapesAsSvg(boolean value)

public void setExportShapesAsSvg(boolean value)

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

If this option is set to true , Shape nodes are exported as elements. Otherwise, they are rendered to bitmaps and are exported as ![Image 1][] elements.

[Image 1]:

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setExportTextInputFormFieldAsText(boolean value)

public void setExportTextInputFormFieldAsText(boolean value)

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

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

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

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setExportTocPageNumbers(boolean value)

public void setExportTocPageNumbers(boolean value)

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

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setExportXhtmlTransitional(boolean value)

public void setExportXhtmlTransitional(boolean value)

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

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

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


 
 
 
 

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

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setFontResourcesSubsettingSizeThreshold(int value)

public void setFontResourcesSubsettingSizeThreshold(int value)

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

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

Font subsetting works as follows:

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

Parameters:

Parameter Type Description
value int The corresponding int value.

setFontSavingCallback(IFontSavingCallback value)

public void setFontSavingCallback(IFontSavingCallback value)

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

Parameters:

Parameter Type Description
value IFontSavingCallback The corresponding IFontSavingCallback value.

setFontsFolder(String value)

public void setFontsFolder(String value)

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

When you save a Document in HTML format and getExportFontResources() / setExportFontResources(boolean) is set to true , Aspose.Words needs to save fonts used in the document as standalone files. getFontsFolder() / setFontsFolder(java.lang.String) allows you to specify where the fonts will be saved and getFontsFolderAlias() / setFontsFolderAlias(java.lang.String) allows to specify how the font URIs will be constructed.

If you save a document into a file and provide a file name, Aspose.Words, by default, saves the fonts in the same folder where the document file is saved. Use getFontsFolder() / setFontsFolder(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 fonts, but still needs to save the fonts somewhere. In this case, you need to specify an accessible folder in the getFontsFolder() / setFontsFolder(java.lang.String) property or provide custom streams via the getFontSavingCallback() / setFontSavingCallback(com.aspose.words.IFontSavingCallback) event handler.

If the folder specified by getFontsFolder() / setFontsFolder(java.lang.String) doesn’t exist, it will be created automatically.

getResourceFolder() / setResourceFolder(java.lang.String) is another way to specify a folder where fonts should be saved.

Parameters:

Parameter Type Description
value java.lang.String The corresponding java.lang.String value.

setFontsFolderAlias(String value)

public void setFontsFolderAlias(String value)

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

When you save a Document in HTML format and getExportFontResources() / setExportFontResources(boolean) is set to true , Aspose.Words needs to save fonts used in the document as standalone files. getFontsFolder() / setFontsFolder(java.lang.String) allows you to specify where the fonts will be saved and getFontsFolderAlias() / setFontsFolderAlias(java.lang.String) allows to specify how the font URIs will be constructed.

If getFontsFolderAlias() / setFontsFolderAlias(java.lang.String) is not an empty string, then the font URI written to HTML will be FontsFolderAlias + .

If getFontsFolderAlias() / setFontsFolderAlias(java.lang.String) is an empty string, then the font URI written to HTML will be FontsFolder + .

If getFontsFolderAlias() / setFontsFolderAlias(java.lang.String) is set to ‘.’ (dot), then the font file name will be written to HTML without path regardless of other options.

Alternative way to specify the name of the folder to construct font URIs is to use getResourceFolderAlias() / setResourceFolderAlias(java.lang.String).

Parameters:

Parameter Type Description
value java.lang.String The corresponding java.lang.String value.

setHtmlVersion(int value)

public void setHtmlVersion(int value)

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

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of HtmlVersion constants.

setImageResolution(int value)

public void setImageResolution(int value)

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

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

Parameters:

Parameter Type Description
value int The corresponding int value.

setImageSavingCallback(IImageSavingCallback value)

public void setImageSavingCallback(IImageSavingCallback value)

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

Parameters:

Parameter Type Description
value IImageSavingCallback The corresponding IImageSavingCallback value.

setImagesFolder(String value)

public void setImagesFolder(String value)

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

When you save a Document in HTML format, Aspose.Words needs to save all images embedded in the document as standalone files. getImagesFolder() / setImagesFolder(java.lang.String) allows you to specify where the images will be saved and getImagesFolderAlias() / setImagesFolderAlias(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 getImagesFolder() / setImagesFolder(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 in the getImagesFolder() / setImagesFolder(java.lang.String) property or provide custom streams via the getImageSavingCallback() / setImageSavingCallback(com.aspose.words.IImageSavingCallback) event handler.

If the folder specified by getImagesFolder() / setImagesFolder(java.lang.String) doesn’t exist, it will be created automatically.

getResourceFolder() / setResourceFolder(java.lang.String) is another way to specify a folder where images should be saved.

Parameters:

Parameter Type Description
value java.lang.String The corresponding java.lang.String value.

setImagesFolderAlias(String value)

public void setImagesFolderAlias(String value)

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

When you save a Document in HTML format, Aspose.Words needs to save all images embedded in the document as standalone files. getImagesFolder() / setImagesFolder(java.lang.String) allows you to specify where the images will be saved and getImagesFolderAlias() / setImagesFolderAlias(java.lang.String) allows to specify how the image URIs will be constructed.

If getImagesFolderAlias() / setImagesFolderAlias(java.lang.String) is not an empty string, then the image URI written to HTML will be ImagesFolderAlias + ![Image 1][].

If getImagesFolderAlias() / setImagesFolderAlias(java.lang.String) is an empty string, then the image URI written to HTML will be ImagesFolder + ![Image 1][].

If getImagesFolderAlias() / setImagesFolderAlias(java.lang.String) is set to ‘.’ (dot), then the image file name will be written to HTML without path regardless of other options.

Alternative way to specify the name of the folder to construct image URIs is to use getResourceFolderAlias() / setResourceFolderAlias(java.lang.String).

[Image 1]:

Parameters:

Parameter Type Description
value java.lang.String The corresponding java.lang.String value.

setImlRenderingMode(int value)

public void setImlRenderingMode(int value)

Sets a value determining how ink (InkML) objects are rendered. The default value is ImlRenderingMode.INK_ML.

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

Parameters:

Parameter Type Description
value int A value determining how ink (InkML) objects are rendered. The value must be one of ImlRenderingMode constants.

setMemoryOptimization(boolean value)

public void setMemoryOptimization(boolean value)

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.

Parameters:

Parameter Type Description
value boolean Value determining if memory optimization should be performed before saving the document.

setMetafileFormat(int value)

public void setMetafileFormat(int value)

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

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

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

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of HtmlMetafileFormat constants.

setOfficeMathOutputMode(int value)

public void setOfficeMathOutputMode(int value)

Controls how OfficeMath objects are exported to HTML, MHTML or EPUB. Default value is HtmlOfficeMathOutputMode.IMAGE.

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of HtmlOfficeMathOutputMode constants.

setPrettyFormat(boolean value)

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.

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setProgressCallback(IDocumentSavingCallback value)

public void setProgressCallback(IDocumentSavingCallback value)

Called during saving a document and accepts data about saving progress.

Progress is reported when saving to SaveFormat.DOCX, SaveFormat.FLAT_OPC, SaveFormat.DOCM, SaveFormat.DOTM, SaveFormat.DOTX, SaveFormat.HTML, SaveFormat.MHTML, SaveFormat.EPUB, SaveFormat.XAML_FLOW, or SaveFormat.XAML_FLOW_PACK.

Parameters:

Parameter Type Description
value IDocumentSavingCallback The corresponding IDocumentSavingCallback value.

setResolveFontNames(boolean value)

public void setResolveFontNames(boolean value)

Specifies whether font family names used in the document are resolved and substituted according to Document.getFontSettings() / Document.setFontSettings(com.aspose.words.FontSettings) when being written into HTML-based formats.

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

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

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setResourceFolder(String value)

public void setResourceFolder(String value)

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

getResourceFolder() / setResourceFolder(java.lang.String) is the simplest way to specify a folder where all resources should be written. Another way is to use individual properties getFontsFolder() / setFontsFolder(java.lang.String), getImagesFolder() / setImagesFolder(java.lang.String), and getCssStyleSheetFileName() / setCssStyleSheetFileName(java.lang.String).

getResourceFolder() / setResourceFolder(java.lang.String) has a lower priority than folders specified via getFontsFolder() / setFontsFolder(java.lang.String), getImagesFolder() / setImagesFolder(java.lang.String), and getCssStyleSheetFileName() / setCssStyleSheetFileName(java.lang.String). For example, if both getResourceFolder() / setResourceFolder(java.lang.String) and getFontsFolder() / setFontsFolder(java.lang.String) are specified, fonts will be saved to getFontsFolder() / setFontsFolder(java.lang.String), while images and CSS will be saved to getResourceFolder() / setResourceFolder(java.lang.String).

If the folder specified by getResourceFolder() / setResourceFolder(java.lang.String) doesn’t exist, it will be created automatically.

Parameters:

Parameter Type Description
value java.lang.String The corresponding java.lang.String value.

setResourceFolderAlias(String value)

public void setResourceFolderAlias(String value)

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

getResourceFolderAlias() / setResourceFolderAlias(java.lang.String) is the simplest way to specify how URIs for all resource files should be constructed. Same information can be specified for images and fonts separately via getImagesFolderAlias() / setImagesFolderAlias(java.lang.String) and getFontsFolderAlias() / setFontsFolderAlias(java.lang.String) properties, respectively. However, there is no individual property for CSS.

getResourceFolderAlias() / setResourceFolderAlias(java.lang.String) has lower priority than getFontsFolderAlias() / setFontsFolderAlias(java.lang.String) and getImagesFolderAlias() / setImagesFolderAlias(java.lang.String). For example, if both getResourceFolderAlias() / setResourceFolderAlias(java.lang.String) and getFontsFolderAlias() / setFontsFolderAlias(java.lang.String) are specified, fonts’ URIs will be constructed using getFontsFolderAlias() / setFontsFolderAlias(java.lang.String), while URIs of images and CSS will be constructed using getResourceFolderAlias() / setResourceFolderAlias(java.lang.String).

If getResourceFolderAlias() / setResourceFolderAlias(java.lang.String) is empty, the getResourceFolder() / setResourceFolder(java.lang.String) property value will be used to construct resource URIs.

If getResourceFolderAlias() / setResourceFolderAlias(java.lang.String) is set to ‘.’ (dot), resource URIs will contain file names only, without any path.

Parameters:

Parameter Type Description
value java.lang.String The corresponding java.lang.String value.

setSaveFormat(int value)

public void setSaveFormat(int value)

Specifies the format in which the document will be saved if this save options object is used. Can be SaveFormat.HTML, SaveFormat.MHTML, SaveFormat.EPUB or SaveFormat.AZW_3.

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of SaveFormat constants.

setScaleImageToShapeSize(boolean value)

public void setScaleImageToShapeSize(boolean value)

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

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

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

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

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

In addition to shapes containing individual raster images, this option also affects group shapes consisting of raster images. If getScaleImageToShapeSize() / setScaleImageToShapeSize(boolean) is false and a group shape contains raster images whose intrinsic resolution is higher than the value specified in getImageResolution() / setImageResolution(int), Aspose.Words will increase rendering resolution for that group. This allows to better preserve quality of grouped high resolution images when saving to HTML.

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setTableWidthOutputMode(int value)

public void setTableWidthOutputMode(int value)

Controls how table, row and cell widths are exported to HTML, MHTML or EPUB. Default value is HtmlElementSizeOutputMode.ALL.

In the HTML format, table, row and cell elements (

| -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ,  | ) can have their widths specified either in relative (percentage) or in absolute units. In a document in Aspose.Words, tables, rows and cells can have their widths specified using either relative or absolute units too.
 
 When you convert a document to HTML using Aspose.Words, you might want to control how table, row and cell widths are exported to affect how the resulting document is displayed in the visual agent (e.g. a browser or viewer).
 
 Use this property as a filter to specify what table widths values are exported into the destination document. For example, if you are converting a document to EPUB and intend to view the document on a mobile reading device, then you probably want to avoid exporting absolute width values. To do this you need to specify the output mode [HtmlElementSizeOutputMode.RELATIVE\_ONLY](../../com.aspose.words/htmlelementsizeoutputmode\#RELATIVE-ONLY) or [HtmlElementSizeOutputMode.NONE](../../com.aspose.words/htmlelementsizeoutputmode\#NONE) so the viewer on the mobile device can layout the table to fit the width of the screen as best as it can. |

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of HtmlElementSizeOutputMode constants.

setTempFolder(String value)

public void setTempFolder(String value)

Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is null and no temporary files are used.

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

If you are saving a very large document (thousands of pages) and/or processing many documents at the same time, then the memory spike during saving can be significant enough to cause the system to throw java.lang.IndexOutOfBoundsException. Specifying a temporary folder using getTempFolder() / setTempFolder(java.lang.String) 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.

Parameters:

Parameter Type Description
value java.lang.String The corresponding java.lang.String value.

setUpdateCreatedTimeProperty(boolean value)

public void setUpdateCreatedTimeProperty(boolean value)

Sets a value determining whether the BuiltInDocumentProperties.getCreatedTime() / BuiltInDocumentProperties.setCreatedTime(java.util.Date) property is updated before saving. Default value is false ;

Parameters:

Parameter Type Description
value boolean A value determining whether the BuiltInDocumentProperties.getCreatedTime() / BuiltInDocumentProperties.setCreatedTime(java.util.Date) property is updated before saving.

setUpdateFields(boolean value)

public void setUpdateFields(boolean value)

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.

Parameters:

Parameter Type Description
value boolean A value determining if fields of certain types should be updated before saving the document to a fixed page format.

setUpdateLastPrintedProperty(boolean value)

public void setUpdateLastPrintedProperty(boolean value)

Sets a value determining whether the BuiltInDocumentProperties.getLastPrinted() / BuiltInDocumentProperties.setLastPrinted(java.util.Date) property is updated before saving.

Parameters:

Parameter Type Description
value boolean A value determining whether the BuiltInDocumentProperties.getLastPrinted() / BuiltInDocumentProperties.setLastPrinted(java.util.Date) property is updated before saving.

setUpdateLastSavedTimeProperty(boolean value)

public void setUpdateLastSavedTimeProperty(boolean value)

Sets a value determining whether the BuiltInDocumentProperties.getLastSavedTime() / BuiltInDocumentProperties.setLastSavedTime(java.util.Date) property is updated before saving.

Parameters:

Parameter Type Description
value boolean A value determining whether the BuiltInDocumentProperties.getLastSavedTime() / BuiltInDocumentProperties.setLastSavedTime(java.util.Date) property is updated before saving.

setUpdateSdtContent(boolean value)

public void setUpdateSdtContent(boolean value)

Sets value determining whether content of StructuredDocumentTag is updated before saving. The default value is false .

Parameters:

Parameter Type Description
value boolean Value determining whether content of StructuredDocumentTag is updated before saving.

setUseAntiAliasing(boolean value)

public void setUseAntiAliasing(boolean value)

Sets a value determining whether or not to use anti-aliasing for rendering.

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

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

Parameters:

Parameter Type Description
value boolean A value determining whether or not to use anti-aliasing for rendering.

setUseHighQualityRendering(boolean value)

public void setUseHighQualityRendering(boolean value)

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.

Parameters:

Parameter Type Description
value boolean A value determining whether or not to use high quality (i.e.

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter Type Description
arg0 long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter Type Description
arg0 long
arg1 int