HtmlSaveOptions
Overview
HtmlSaveOptions is a class in Aspose.Words FOSS for Java.
Inherits from: SaveOptions, Cloneable.
Can be used to specify additional options when saving a document into the SaveFormat.HTML, SaveFormat.MHTML, SaveFormat.EPUB, SaveFormat.AZW_3 or SaveFormat.MOBI format.
Edition status of its 200 listed members (a property and its accessor methods are listed separately, overloads once): 200 not yet exercised by a verified example.
This class declares 136 methods for HtmlSaveOptions objects in Java programs.
Available methods include: HtmlSaveOptions, createSaveOptions, getAllowEmbeddingPostScriptFonts, getAllowNegativeIndent, getCssClassNamePrefix, getCssSavingCallback, getCssStyleSheetFileName, getCssStyleSheetType, getCustomTimeZoneInfo, getDefaultTemplate, getDml3DEffectsRenderingMode, getDmlEffectsRenderingMode, and 122 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: allowEmbeddingPostScriptFonts, allowNegativeIndent, cssClassNamePrefix, cssSavingCallback, cssStyleSheetFileName, cssStyleSheetType, and 60 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
saveFormat | int | Read/Write | Specifies the format in which the document will be saved if this save options object is used. |
allowNegativeIndent | boolean | Read/Write | Specifies whether negative left and right indents of paragraphs are normalized when saving to HTML, MHTML or EPUB. |
cssStyleSheetFileName | String | Read/Write | Specifies the path and the name of the Cascading Style Sheet (CSS) file written when a document is exported to HTML. |
cssStyleSheetType | int | Read/Write | Specifies how CSS (Cascading Style Sheet) styles are exported to HTML, MHTML or EPUB. |
cssClassNamePrefix | String | Read/Write | Specifies a prefix which is added to all CSS class names. |
documentPartSavingCallback | IDocumentPartSavingCallback | Read/Write | Allows to control how document parts are saved when a document is saved to HTML or EPUB. |
cssSavingCallback | ICssSavingCallback | Read/Write | Allows to control how CSS styles are saved when a document is saved to HTML, MHTML or EPUB. |
documentSplitCriteria | int | Read/Write | Specifies how the document should be split when saving to SaveFormat.HTML, SaveFormat.EPUB or SaveFormat.AZW_3 format. |
documentSplitHeadingLevel | int | Read/Write | Specifies the maximum level of headings at which to split the document. |
encoding | java.nio.charset.Charset | Read/Write | Gets or sets the encoding. |
navigationMapLevel | int | Read/Write | Specifies the maximum level of headings populated to the navigation map when exporting to EPUB, MOBI, or AZW3 formats. |
exportDocumentProperties | boolean | Read/Write | Specifies whether to export built-in and custom document properties to HTML, MHTML or EPUB. |
exportFontResources | boolean | Read/Write | Specifies whether font resources should be exported to HTML, MHTML or EPUB. |
exportFontsAsBase64 | boolean | Read/Write | Specifies whether fonts resources should be embedded to HTML in Base64 encoding. |
exportHeadersFootersMode | int | Read/Write | Specifies how headers and footers are output to HTML, MHTML or EPUB. |
exportImagesAsBase64 | boolean | Read/Write | Specifies whether images are saved in Base64 format to the output HTML, MHTML or EPUB. |
exportLanguageInformation | boolean | Read/Write | Specifies whether language information is exported to HTML, MHTML or EPUB. |
exportListLabels | int | Read/Write | Controls how list labels are output to HTML, MHTML or EPUB. |
metafileFormat | int | Read/Write | Specifies in what format metafiles are saved when exporting to HTML, MHTML, or EPUB. |
exportPageSetup | boolean | Read/Write | Specifies whether page setup is exported to HTML, MHTML or EPUB. |
exportPageMargins | boolean | Read/Write | Specifies whether page margins is exported to HTML, MHTML or EPUB. |
exportRelativeFontSize | boolean | Read/Write | Specifies whether font sizes should be output in relative units when saving to HTML, MHTML or EPUB. |
exportTextInputFormFieldAsText | boolean | Read/Write | Controls how text input form fields are saved to HTML or MHTML. |
exportShapesAsSvg | boolean | Read/Write | Controls whether Shape nodes are converted to SVG images when saving to HTML, MHTML, EPUB or AZW3. |
exportDropDownFormFieldAsText | boolean | Read/Write | Controls how drop-down form fields are saved to HTML or MHTML. |
exportTocPageNumbers | boolean | Read/Write | Specifies whether to write page numbers to table of contents when saving HTML, MHTML and EPUB. |
exportXhtmlTransitional | boolean | Read/Write | Specifies whether to write the DOCTYPE declaration when saving to HTML or MHTML. |
htmlVersion | int | Read/Write | Specifies version of HTML standard that should be used when saving the document to HTML or MHTML. |
exportRoundtripInformation | boolean | Read/Write | Specifies whether to write the roundtrip information when saving to HTML, MHTML or EPUB. |
resourceFolder | String | Read/Write | Specifies a physical folder where all resources like images, fonts, and external CSS are saved when a document is exported to HTML. |
resourceFolderAlias | String | Read/Write | Specifies the name of the folder used to construct URIs of all resources written into an HTML document. |
fontsFolder | String | Read/Write | Specifies the physical folder where fonts are saved when exporting a document to HTML. |
fontsFolderAlias | String | Read/Write | Specifies the name of the folder used to construct font URIs written into an HTML document. |
fontResourcesSubsettingSizeThreshold | int | Read/Write | Controls which font resources need subsetting when saving to HTML, MHTML or EPUB. |
imagesFolder | String | Read/Write | Specifies the physical folder where images are saved when exporting a document to HTML format. |
imagesFolderAlias | String | Read/Write | Specifies the name of the folder used to construct image URIs written into an HTML document. |
imageResolution | int | Read/Write | Specifies the output resolution for images when exporting to HTML, MHTML or EPUB. |
imageSavingCallback | IImageSavingCallback | Read/Write | Allows to control how images are saved when a document is saved to HTML, MHTML or EPUB. |
scaleImageToShapeSize | boolean | Read/Write | Specifies whether images are scaled by Aspose.Words to the bounding shape size when exporting to HTML, MHTML or EPUB. |
tableWidthOutputMode | int | Read/Write | Controls how table, row and cell widths are exported to HTML, MHTML or EPUB. |
officeMathOutputMode | int | Read/Write | Controls how OfficeMath objects are exported to HTML, MHTML or EPUB. |
exportOriginalUrlForLinkedImages | boolean | Read/Write | Specifies whether original URL should be used as the URL of the linked images. |
exportCidUrlsForMhtmlResources | boolean | Read/Write | Specifies whether to use CID (Content-ID) URLs to reference resources (images, fonts, CSS) included in MHTML documents. |
resolveFontNames | boolean | Read/Write | Specifies whether font family names used in the document are resolved and substituted according to FontSettings when being written into HTML-based formats. |
replaceBackslashWithYenSign | boolean | Read/Write | Specifies whether backslash characters should be replaced with yen signs. |
removeJavaScriptFromLinks | boolean | Read/Write | Specifies whether JavaScript will be removed from links. |
exportGeneratorName | boolean | Read/Write | When true, causes the name and version of Aspose.Words to be embedded into produced files. |
tempFolder | String | Read/Write | Specifies the folder for temporary files used when saving to a DOC or DOCX file. |
updateOleControlImages | boolean | Read/Write | Gets or sets a value determining whether OLE controls presentation image will be updated. |
prettyFormat | boolean | Read/Write | When true, pretty formats output where applicable. |
useAntiAliasing | boolean | Read/Write | Gets or sets a value determining whether or not to use anti-aliasing for rendering. |
useHighQualityRendering | boolean | Read/Write | Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. |
dmlRenderingMode | int | Read/Write | Gets or sets a value determining how DrawingML shapes are rendered. |
dmlEffectsRenderingMode | int | Read/Write | Gets or sets a value determining how DrawingML effects are rendered. |
imlRenderingMode | int | Read/Write | Gets or sets a value determining how ink (InkML) objects are rendered. |
defaultTemplate | String | Read/Write | Gets or sets path to default template (including filename). |
updateFields | boolean | Read/Write | Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. |
updateLastSavedTimeProperty | boolean | Read/Write | Gets or sets a value determining whether the BuiltInDocumentProperties.getLastSavedTime() property is updated before saving. |
updateLastPrintedProperty | boolean | Read/Write | Gets or sets a value determining whether the BuiltInDocumentProperties.getLastPrinted() property is updated before saving. |
updateCreatedTimeProperty | boolean | Read/Write | Gets or sets a value determining whether the BuiltInDocumentProperties.getCreatedTime() property is updated before saving. |
memoryOptimization | boolean | Read/Write | Gets or sets value determining if memory optimization should be performed before saving the document. |
updateAmbiguousTextFont | boolean | Read/Write | Determines whether the font attributes will be changed according to the character code being used. |
dml3DEffectsRenderingMode | int | Read/Write | Gets or sets a value determining how 3D effects are rendered. |
progressCallback | IDocumentSavingCallback | Read/Write | Called during saving a document and accepts data about saving progress. |
allowEmbeddingPostScriptFonts | boolean | Read/Write | Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. |
customTimeZoneInfo | TimeZone | Read/Write | Gets or sets custom local time zone used for date/time fields. |
Methods
| Signature | Description |
|---|---|
HtmlSaveOptions() | Initializes a new instance of this class that can be used to save a document in the SaveFormat.HTML format. |
HtmlSaveOptions(saveFormat: int) | Initializes a new instance of this class that can be used to save a document in the SaveFormat.HTML, SaveFormat.MHTML, SaveFormat.EPUB, SaveFormat.AZW_3 or SaveFormat.MOBI format. |
getSaveFormat() → int | Specifies the format in which the document will be saved if this save options object is used. |
setSaveFormat(value: int) | Sets the save format value. |
getAllowNegativeIndent() → boolean | Specifies whether negative left and right indents of paragraphs are normalized when saving to HTML, MHTML or EPUB. |
setAllowNegativeIndent(value: boolean) | Sets the allow negative indent value. |
getCssStyleSheetFileName() → String | Specifies the path and the name of the Cascading Style Sheet (CSS) file written when a document is exported to HTML. |
setCssStyleSheetFileName(value: String) | Sets the css style sheet file name value. |
getCssStyleSheetType() → int | Specifies how CSS (Cascading Style Sheet) styles are exported to HTML, MHTML or EPUB. |
setCssStyleSheetType(value: int) | Sets the css style sheet type value. |
getCssClassNamePrefix() → String | Specifies a prefix which is added to all CSS class names. |
setCssClassNamePrefix(value: String) | Sets the css class name prefix value. |
getDocumentPartSavingCallback() → IDocumentPartSavingCallback | Allows to control how document parts are saved when a document is saved to HTML or EPUB. |
setDocumentPartSavingCallback(value: IDocumentPartSavingCallback) | Sets the document part saving callback value. |
getCssSavingCallback() → ICssSavingCallback | Allows to control how CSS styles are saved when a document is saved to HTML, MHTML or EPUB. |
setCssSavingCallback(value: ICssSavingCallback) | Sets the css saving callback value. |
getDocumentSplitCriteria() → int | Specifies how the document should be split when saving to SaveFormat.HTML, SaveFormat.EPUB or SaveFormat.AZW_3 format. |
setDocumentSplitCriteria(value: int) | Sets the document split criteria value. |
getDocumentSplitHeadingLevel() → int | Specifies the maximum level of headings at which to split the document. |
setDocumentSplitHeadingLevel(value: int) | Sets the document split heading level value. |
getEncoding() → java.nio.charset.Charset | Returns the encoding. |
setEncoding(value: java.nio.charset.Charset) | Sets the encoding value. |
getNavigationMapLevel() → int | Specifies the maximum level of headings populated to the navigation map when exporting to EPUB, MOBI, or AZW3 formats. |
setNavigationMapLevel(value: int) | Sets the navigation map level value. |
getExportDocumentProperties() → boolean | Specifies whether to export built-in and custom document properties to HTML, MHTML or EPUB. |
setExportDocumentProperties(value: boolean) | Sets the export document properties value. |
getExportFontResources() → boolean | Specifies whether font resources should be exported to HTML, MHTML or EPUB. |
setExportFontResources(value: boolean) | Sets the export font resources value. |
getExportFontsAsBase64() → boolean | Specifies whether fonts resources should be embedded to HTML in Base64 encoding. |
setExportFontsAsBase64(value: boolean) | Sets the export fonts as base64 value. |
getExportHeadersFootersMode() → int | Specifies how headers and footers are output to HTML, MHTML or EPUB. |
setExportHeadersFootersMode(value: int) | Sets the export headers footers mode value. |
getExportImagesAsBase64() → boolean | Specifies whether images are saved in Base64 format to the output HTML, MHTML or EPUB. |
setExportImagesAsBase64(value: boolean) | Sets the export images as base64 value. |
getExportLanguageInformation() → boolean | Specifies whether language information is exported to HTML, MHTML or EPUB. |
setExportLanguageInformation(value: boolean) | Sets the export language information value. |
getExportListLabels() → int | Controls how list labels are output to HTML, MHTML or EPUB. |
setExportListLabels(value: int) | Sets the export list labels value. |
getMetafileFormat() → int | Specifies in what format metafiles are saved when exporting to HTML, MHTML, or EPUB. |
setMetafileFormat(value: int) | Sets the metafile format value. |
getExportPageSetup() → boolean | Specifies whether page setup is exported to HTML, MHTML or EPUB. |
setExportPageSetup(value: boolean) | Sets the export page setup value. |
getExportPageMargins() → boolean | Specifies whether page margins is exported to HTML, MHTML or EPUB. |
setExportPageMargins(value: boolean) | Sets the export page margins value. |
getExportRelativeFontSize() → boolean | Specifies whether font sizes should be output in relative units when saving to HTML, MHTML or EPUB. |
setExportRelativeFontSize(value: boolean) | Sets the export relative font size value. |
getExportTextInputFormFieldAsText() → boolean | Controls how text input form fields are saved to HTML or MHTML. |
setExportTextInputFormFieldAsText(value: boolean) | Sets the export text input form field as text value. |
getExportShapesAsSvg() → boolean | Controls whether Shape nodes are converted to SVG images when saving to HTML, MHTML, EPUB or AZW3. |
setExportShapesAsSvg(value: boolean) | Sets the export shapes as svg value. |
getExportDropDownFormFieldAsText() → boolean | Controls how drop-down form fields are saved to HTML or MHTML. |
setExportDropDownFormFieldAsText(value: boolean) | Sets the export drop down form field as text value. |
getExportTocPageNumbers() → boolean | Specifies whether to write page numbers to table of contents when saving HTML, MHTML and EPUB. |
setExportTocPageNumbers(value: boolean) | Sets the export toc page numbers value. |
getExportXhtmlTransitional() → boolean | Specifies whether to write the DOCTYPE declaration when saving to HTML or MHTML. |
setExportXhtmlTransitional(value: boolean) | Sets the export xhtml transitional value. |
getHtmlVersion() → int | Specifies version of HTML standard that should be used when saving the document to HTML or MHTML. |
setHtmlVersion(value: int) | Sets the html version value. |
getExportRoundtripInformation() → boolean | Specifies whether to write the roundtrip information when saving to HTML, MHTML or EPUB. |
setExportRoundtripInformation(value: boolean) | Sets the export roundtrip information value. |
getResourceFolder() → String | Specifies a physical folder where all resources like images, fonts, and external CSS are saved when a document is exported to HTML. |
setResourceFolder(value: String) | Sets the resource folder value. |
getResourceFolderAlias() → String | Specifies the name of the folder used to construct URIs of all resources written into an HTML document. |
setResourceFolderAlias(value: String) | Sets the resource folder alias value. |
getFontsFolder() → String | Specifies the physical folder where fonts are saved when exporting a document to HTML. |
setFontsFolder(value: String) | Sets the fonts folder value. |
getFontsFolderAlias() → String | Specifies the name of the folder used to construct font URIs written into an HTML document. |
setFontsFolderAlias(value: String) | Sets the fonts folder alias value. |
getFontResourcesSubsettingSizeThreshold() → int | Controls which font resources need subsetting when saving to HTML, MHTML or EPUB. |
setFontResourcesSubsettingSizeThreshold(value: int) | Sets the font resources subsetting size threshold value. |
getImagesFolder() → String | Specifies the physical folder where images are saved when exporting a document to HTML format. |
setImagesFolder(value: String) | Sets the images folder value. |
getImagesFolderAlias() → String | Specifies the name of the folder used to construct image URIs written into an HTML document. |
setImagesFolderAlias(value: String) | Sets the images folder alias value. |
getImageResolution() → int | Specifies the output resolution for images when exporting to HTML, MHTML or EPUB. |
setImageResolution(value: int) | Sets the image resolution value. |
getImageSavingCallback() → IImageSavingCallback | Allows to control how images are saved when a document is saved to HTML, MHTML or EPUB. |
setImageSavingCallback(value: IImageSavingCallback) | Sets the image saving callback value. |
getScaleImageToShapeSize() → boolean | Specifies whether images are scaled by Aspose.Words to the bounding shape size when exporting to HTML, MHTML or EPUB. |
setScaleImageToShapeSize(value: boolean) | Sets the scale image to shape size value. |
getTableWidthOutputMode() → int | Controls how table, row and cell widths are exported to HTML, MHTML or EPUB. |
setTableWidthOutputMode(value: int) | Sets the table width output mode value. |
getOfficeMathOutputMode() → int | Controls how OfficeMath objects are exported to HTML, MHTML or EPUB. |
setOfficeMathOutputMode(value: int) | Sets the office math output mode value. |
getExportOriginalUrlForLinkedImages() → boolean | Specifies whether original URL should be used as the URL of the linked images. |
setExportOriginalUrlForLinkedImages(value: boolean) | Sets the export original url for linked images value. |
getExportCidUrlsForMhtmlResources() → boolean | Specifies whether to use CID (Content-ID) URLs to reference resources (images, fonts, CSS) included in MHTML documents. |
setExportCidUrlsForMhtmlResources(value: boolean) | Sets the export cid urls for mhtml resources value. |
getResolveFontNames() → boolean | Specifies whether font family names used in the document are resolved and substituted according to FontSettings when being written into HTML-based formats. |
setResolveFontNames(value: boolean) | Sets the resolve font names value. |
getReplaceBackslashWithYenSign() → boolean | Specifies whether backslash characters should be replaced with yen signs. |
setReplaceBackslashWithYenSign(value: boolean) | Sets the replace backslash with yen sign value. |
getRemoveJavaScriptFromLinks() → boolean | Specifies whether JavaScript will be removed from links. |
setRemoveJavaScriptFromLinks(value: boolean) | Sets the remove java script from links value. |
getExportGeneratorName() → boolean | When true, causes the name and version of Aspose.Words to be embedded into produced files. |
setExportGeneratorName(value: boolean) | Sets the export generator name value. |
getTempFolder() → String | Specifies the folder for temporary files used when saving to a DOC or DOCX file. |
setTempFolder(value: String) | Sets the temp folder value. |
getUpdateOleControlImages() → boolean | Gets or sets a value determining whether OLE controls presentation image will be updated. |
setUpdateOleControlImages(value: boolean) | Sets the update ole control images value. |
getPrettyFormat() → boolean | When true, pretty formats output where applicable. |
setPrettyFormat(value: boolean) | Sets the pretty format value. |
getUseAntiAliasing() → boolean | Gets or sets a value determining whether or not to use anti-aliasing for rendering. |
setUseAntiAliasing(value: boolean) | Sets the use anti aliasing value. |
getUseHighQualityRendering() → boolean | Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. |
setUseHighQualityRendering(value: boolean) | Sets the use high quality rendering value. |
getDmlRenderingMode() → int | Gets or sets a value determining how DrawingML shapes are rendered. |
setDmlRenderingMode(value: int) | Sets the dml rendering mode value. |
getDmlEffectsRenderingMode() → int | Gets or sets a value determining how DrawingML effects are rendered. |
setDmlEffectsRenderingMode(value: int) | Sets the dml effects rendering mode value. |
getImlRenderingMode() → int | Gets or sets a value determining how ink (InkML) objects are rendered. |
setImlRenderingMode(value: int) | Sets the iml rendering mode value. |
getDefaultTemplate() → String | Gets or sets path to default template (including filename). |
setDefaultTemplate(value: String) | Sets the default template value. |
getUpdateFields() → boolean | Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. |
setUpdateFields(value: boolean) | Sets the update fields value. |
getUpdateLastSavedTimeProperty() → boolean | Gets or sets a value determining whether the BuiltInDocumentProperties.getLastSavedTime() property is updated before saving. |
setUpdateLastSavedTimeProperty(value: boolean) | Sets the update last saved time property value. |
getUpdateLastPrintedProperty() → boolean | Gets or sets a value determining whether the BuiltInDocumentProperties.getLastPrinted() property is updated before saving. |
setUpdateLastPrintedProperty(value: boolean) | Sets the update last printed property value. |
getUpdateCreatedTimeProperty() → boolean | Gets or sets a value determining whether the BuiltInDocumentProperties.getCreatedTime() property is updated before saving. |
setUpdateCreatedTimeProperty(value: boolean) | Sets the update created time property value. |
getMemoryOptimization() → boolean | Gets or sets value determining if memory optimization should be performed before saving the document. |
setMemoryOptimization(value: boolean) | Sets the memory optimization value. |
getUpdateAmbiguousTextFont() → boolean | Determines whether the font attributes will be changed according to the character code being used. |
setUpdateAmbiguousTextFont(value: boolean) | Sets the update ambiguous text font value. |
createSaveOptions(saveFormat: int) → SaveOptions | Creates a save options object of a class suitable for the specified save format. |
createSaveOptions(fileName: String) → SaveOptions | Creates a save options object of a class suitable for the file extension specified in the given file name. |
getDml3DEffectsRenderingMode() → int | Gets or sets a value determining how 3D effects are rendered. |
setDml3DEffectsRenderingMode(value: int) | Sets the dml3 d effects rendering mode value. |
getProgressCallback() → IDocumentSavingCallback | Called during saving a document and accepts data about saving progress. |
setProgressCallback(value: IDocumentSavingCallback) | Sets the progress callback value. |
getAllowEmbeddingPostScriptFonts() → boolean | Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. |
setAllowEmbeddingPostScriptFonts(value: boolean) | Sets the allow embedding post script fonts value. |
getCustomTimeZoneInfo() → TimeZone | Gets or sets custom local time zone used for date/time fields. |
setCustomTimeZoneInfo(value: TimeZone) | Sets the custom time zone info value. |