HtmlSaveOptions

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

NameTypeAccessDescription
saveFormatintRead/WriteSpecifies the format in which the document will be saved if this save options object is used.
allowNegativeIndentbooleanRead/WriteSpecifies whether negative left and right indents of paragraphs are normalized when saving to HTML, MHTML or EPUB.
cssStyleSheetFileNameStringRead/WriteSpecifies the path and the name of the Cascading Style Sheet (CSS) file written when a document is exported to HTML.
cssStyleSheetTypeintRead/WriteSpecifies how CSS (Cascading Style Sheet) styles are exported to HTML, MHTML or EPUB.
cssClassNamePrefixStringRead/WriteSpecifies a prefix which is added to all CSS class names.
documentPartSavingCallbackIDocumentPartSavingCallbackRead/WriteAllows to control how document parts are saved when a document is saved to HTML or EPUB.
cssSavingCallbackICssSavingCallbackRead/WriteAllows to control how CSS styles are saved when a document is saved to HTML, MHTML or EPUB.
documentSplitCriteriaintRead/WriteSpecifies how the document should be split when saving to SaveFormat.HTML, SaveFormat.EPUB or SaveFormat.AZW_3 format.
documentSplitHeadingLevelintRead/WriteSpecifies the maximum level of headings at which to split the document.
encodingjava.nio.charset.CharsetRead/WriteGets or sets the encoding.
navigationMapLevelintRead/WriteSpecifies the maximum level of headings populated to the navigation map when exporting to EPUB, MOBI, or AZW3 formats.
exportDocumentPropertiesbooleanRead/WriteSpecifies whether to export built-in and custom document properties to HTML, MHTML or EPUB.
exportFontResourcesbooleanRead/WriteSpecifies whether font resources should be exported to HTML, MHTML or EPUB.
exportFontsAsBase64booleanRead/WriteSpecifies whether fonts resources should be embedded to HTML in Base64 encoding.
exportHeadersFootersModeintRead/WriteSpecifies how headers and footers are output to HTML, MHTML or EPUB.
exportImagesAsBase64booleanRead/WriteSpecifies whether images are saved in Base64 format to the output HTML, MHTML or EPUB.
exportLanguageInformationbooleanRead/WriteSpecifies whether language information is exported to HTML, MHTML or EPUB.
exportListLabelsintRead/WriteControls how list labels are output to HTML, MHTML or EPUB.
metafileFormatintRead/WriteSpecifies in what format metafiles are saved when exporting to HTML, MHTML, or EPUB.
exportPageSetupbooleanRead/WriteSpecifies whether page setup is exported to HTML, MHTML or EPUB.
exportPageMarginsbooleanRead/WriteSpecifies whether page margins is exported to HTML, MHTML or EPUB.
exportRelativeFontSizebooleanRead/WriteSpecifies whether font sizes should be output in relative units when saving to HTML, MHTML or EPUB.
exportTextInputFormFieldAsTextbooleanRead/WriteControls how text input form fields are saved to HTML or MHTML.
exportShapesAsSvgbooleanRead/WriteControls whether Shape nodes are converted to SVG images when saving to HTML, MHTML, EPUB or AZW3.
exportDropDownFormFieldAsTextbooleanRead/WriteControls how drop-down form fields are saved to HTML or MHTML.
exportTocPageNumbersbooleanRead/WriteSpecifies whether to write page numbers to table of contents when saving HTML, MHTML and EPUB.
exportXhtmlTransitionalbooleanRead/WriteSpecifies whether to write the DOCTYPE declaration when saving to HTML or MHTML.
htmlVersionintRead/WriteSpecifies version of HTML standard that should be used when saving the document to HTML or MHTML.
exportRoundtripInformationbooleanRead/WriteSpecifies whether to write the roundtrip information when saving to HTML, MHTML or EPUB.
resourceFolderStringRead/WriteSpecifies a physical folder where all resources like images, fonts, and external CSS are saved when a document is exported to HTML.
resourceFolderAliasStringRead/WriteSpecifies the name of the folder used to construct URIs of all resources written into an HTML document.
fontsFolderStringRead/WriteSpecifies the physical folder where fonts are saved when exporting a document to HTML.
fontsFolderAliasStringRead/WriteSpecifies the name of the folder used to construct font URIs written into an HTML document.
fontResourcesSubsettingSizeThresholdintRead/WriteControls which font resources need subsetting when saving to HTML, MHTML or EPUB.
imagesFolderStringRead/WriteSpecifies the physical folder where images are saved when exporting a document to HTML format.
imagesFolderAliasStringRead/WriteSpecifies the name of the folder used to construct image URIs written into an HTML document.
imageResolutionintRead/WriteSpecifies the output resolution for images when exporting to HTML, MHTML or EPUB.
imageSavingCallbackIImageSavingCallbackRead/WriteAllows to control how images are saved when a document is saved to HTML, MHTML or EPUB.
scaleImageToShapeSizebooleanRead/WriteSpecifies whether images are scaled by Aspose.Words to the bounding shape size when exporting to HTML, MHTML or EPUB.
tableWidthOutputModeintRead/WriteControls how table, row and cell widths are exported to HTML, MHTML or EPUB.
officeMathOutputModeintRead/WriteControls how OfficeMath objects are exported to HTML, MHTML or EPUB.
exportOriginalUrlForLinkedImagesbooleanRead/WriteSpecifies whether original URL should be used as the URL of the linked images.
exportCidUrlsForMhtmlResourcesbooleanRead/WriteSpecifies whether to use CID (Content-ID) URLs to reference resources (images, fonts, CSS) included in MHTML documents.
resolveFontNamesbooleanRead/WriteSpecifies whether font family names used in the document are resolved and substituted according to FontSettings when being written into HTML-based formats.
replaceBackslashWithYenSignbooleanRead/WriteSpecifies whether backslash characters should be replaced with yen signs.
removeJavaScriptFromLinksbooleanRead/WriteSpecifies whether JavaScript will be removed from links.
exportGeneratorNamebooleanRead/WriteWhen true, causes the name and version of Aspose.Words to be embedded into produced files.
tempFolderStringRead/WriteSpecifies the folder for temporary files used when saving to a DOC or DOCX file.
updateOleControlImagesbooleanRead/WriteGets or sets a value determining whether OLE controls presentation image will be updated.
prettyFormatbooleanRead/WriteWhen true, pretty formats output where applicable.
useAntiAliasingbooleanRead/WriteGets or sets a value determining whether or not to use anti-aliasing for rendering.
useHighQualityRenderingbooleanRead/WriteGets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
dmlRenderingModeintRead/WriteGets or sets a value determining how DrawingML shapes are rendered.
dmlEffectsRenderingModeintRead/WriteGets or sets a value determining how DrawingML effects are rendered.
imlRenderingModeintRead/WriteGets or sets a value determining how ink (InkML) objects are rendered.
defaultTemplateStringRead/WriteGets or sets path to default template (including filename).
updateFieldsbooleanRead/WriteGets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format.
updateLastSavedTimePropertybooleanRead/WriteGets or sets a value determining whether the BuiltInDocumentProperties.getLastSavedTime() property is updated before saving.
updateLastPrintedPropertybooleanRead/WriteGets or sets a value determining whether the BuiltInDocumentProperties.getLastPrinted() property is updated before saving.
updateCreatedTimePropertybooleanRead/WriteGets or sets a value determining whether the BuiltInDocumentProperties.getCreatedTime() property is updated before saving.
memoryOptimizationbooleanRead/WriteGets or sets value determining if memory optimization should be performed before saving the document.
updateAmbiguousTextFontbooleanRead/WriteDetermines whether the font attributes will be changed according to the character code being used.
dml3DEffectsRenderingModeintRead/WriteGets or sets a value determining how 3D effects are rendered.
progressCallbackIDocumentSavingCallbackRead/WriteCalled during saving a document and accepts data about saving progress.
allowEmbeddingPostScriptFontsbooleanRead/WriteGets 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.
customTimeZoneInfoTimeZoneRead/WriteGets or sets custom local time zone used for date/time fields.

Methods

SignatureDescription
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() → intSpecifies 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() → booleanSpecifies 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() → StringSpecifies 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() → intSpecifies how CSS (Cascading Style Sheet) styles are exported to HTML, MHTML or EPUB.
setCssStyleSheetType(value: int)Sets the css style sheet type value.
getCssClassNamePrefix() → StringSpecifies a prefix which is added to all CSS class names.
setCssClassNamePrefix(value: String)Sets the css class name prefix value.
getDocumentPartSavingCallback() → IDocumentPartSavingCallbackAllows 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() → ICssSavingCallbackAllows 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() → intSpecifies 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() → intSpecifies 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.CharsetReturns the encoding.
setEncoding(value: java.nio.charset.Charset)Sets the encoding value.
getNavigationMapLevel() → intSpecifies 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() → booleanSpecifies whether to export built-in and custom document properties to HTML, MHTML or EPUB.
setExportDocumentProperties(value: boolean)Sets the export document properties value.
getExportFontResources() → booleanSpecifies whether font resources should be exported to HTML, MHTML or EPUB.
setExportFontResources(value: boolean)Sets the export font resources value.
getExportFontsAsBase64() → booleanSpecifies whether fonts resources should be embedded to HTML in Base64 encoding.
setExportFontsAsBase64(value: boolean)Sets the export fonts as base64 value.
getExportHeadersFootersMode() → intSpecifies how headers and footers are output to HTML, MHTML or EPUB.
setExportHeadersFootersMode(value: int)Sets the export headers footers mode value.
getExportImagesAsBase64() → booleanSpecifies 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() → booleanSpecifies whether language information is exported to HTML, MHTML or EPUB.
setExportLanguageInformation(value: boolean)Sets the export language information value.
getExportListLabels() → intControls how list labels are output to HTML, MHTML or EPUB.
setExportListLabels(value: int)Sets the export list labels value.
getMetafileFormat() → intSpecifies in what format metafiles are saved when exporting to HTML, MHTML, or EPUB.
setMetafileFormat(value: int)Sets the metafile format value.
getExportPageSetup() → booleanSpecifies whether page setup is exported to HTML, MHTML or EPUB.
setExportPageSetup(value: boolean)Sets the export page setup value.
getExportPageMargins() → booleanSpecifies whether page margins is exported to HTML, MHTML or EPUB.
setExportPageMargins(value: boolean)Sets the export page margins value.
getExportRelativeFontSize() → booleanSpecifies 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() → booleanControls 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() → booleanControls 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() → booleanControls 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() → booleanSpecifies 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() → booleanSpecifies whether to write the DOCTYPE declaration when saving to HTML or MHTML.
setExportXhtmlTransitional(value: boolean)Sets the export xhtml transitional value.
getHtmlVersion() → intSpecifies 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() → booleanSpecifies whether to write the roundtrip information when saving to HTML, MHTML or EPUB.
setExportRoundtripInformation(value: boolean)Sets the export roundtrip information value.
getResourceFolder() → StringSpecifies 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() → StringSpecifies 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() → StringSpecifies the physical folder where fonts are saved when exporting a document to HTML.
setFontsFolder(value: String)Sets the fonts folder value.
getFontsFolderAlias() → StringSpecifies 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() → intControls which font resources need subsetting when saving to HTML, MHTML or EPUB.
setFontResourcesSubsettingSizeThreshold(value: int)Sets the font resources subsetting size threshold value.
getImagesFolder() → StringSpecifies the physical folder where images are saved when exporting a document to HTML format.
setImagesFolder(value: String)Sets the images folder value.
getImagesFolderAlias() → StringSpecifies 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() → intSpecifies the output resolution for images when exporting to HTML, MHTML or EPUB.
setImageResolution(value: int)Sets the image resolution value.
getImageSavingCallback() → IImageSavingCallbackAllows 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() → booleanSpecifies 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() → intControls how table, row and cell widths are exported to HTML, MHTML or EPUB.
setTableWidthOutputMode(value: int)Sets the table width output mode value.
getOfficeMathOutputMode() → intControls how OfficeMath objects are exported to HTML, MHTML or EPUB.
setOfficeMathOutputMode(value: int)Sets the office math output mode value.
getExportOriginalUrlForLinkedImages() → booleanSpecifies 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() → booleanSpecifies 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() → booleanSpecifies 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() → booleanSpecifies whether backslash characters should be replaced with yen signs.
setReplaceBackslashWithYenSign(value: boolean)Sets the replace backslash with yen sign value.
getRemoveJavaScriptFromLinks() → booleanSpecifies whether JavaScript will be removed from links.
setRemoveJavaScriptFromLinks(value: boolean)Sets the remove java script from links value.
getExportGeneratorName() → booleanWhen 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() → StringSpecifies the folder for temporary files used when saving to a DOC or DOCX file.
setTempFolder(value: String)Sets the temp folder value.
getUpdateOleControlImages() → booleanGets or sets a value determining whether OLE controls presentation image will be updated.
setUpdateOleControlImages(value: boolean)Sets the update ole control images value.
getPrettyFormat() → booleanWhen true, pretty formats output where applicable.
setPrettyFormat(value: boolean)Sets the pretty format value.
getUseAntiAliasing() → booleanGets or sets a value determining whether or not to use anti-aliasing for rendering.
setUseAntiAliasing(value: boolean)Sets the use anti aliasing value.
getUseHighQualityRendering() → booleanGets 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() → intGets or sets a value determining how DrawingML shapes are rendered.
setDmlRenderingMode(value: int)Sets the dml rendering mode value.
getDmlEffectsRenderingMode() → intGets or sets a value determining how DrawingML effects are rendered.
setDmlEffectsRenderingMode(value: int)Sets the dml effects rendering mode value.
getImlRenderingMode() → intGets or sets a value determining how ink (InkML) objects are rendered.
setImlRenderingMode(value: int)Sets the iml rendering mode value.
getDefaultTemplate() → StringGets or sets path to default template (including filename).
setDefaultTemplate(value: String)Sets the default template value.
getUpdateFields() → booleanGets 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() → booleanGets 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() → booleanGets 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() → booleanGets 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() → booleanGets or sets value determining if memory optimization should be performed before saving the document.
setMemoryOptimization(value: boolean)Sets the memory optimization value.
getUpdateAmbiguousTextFont() → booleanDetermines 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) → SaveOptionsCreates a save options object of a class suitable for the specified save format.
createSaveOptions(fileName: String) → SaveOptionsCreates a save options object of a class suitable for the file extension specified in the given file name.
getDml3DEffectsRenderingMode() → intGets or sets a value determining how 3D effects are rendered.
setDml3DEffectsRenderingMode(value: int)Sets the dml3 d effects rendering mode value.
getProgressCallback() → IDocumentSavingCallbackCalled during saving a document and accepts data about saving progress.
setProgressCallback(value: IDocumentSavingCallback)Sets the progress callback value.
getAllowEmbeddingPostScriptFonts() → booleanGets 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() → TimeZoneGets or sets custom local time zone used for date/time fields.
setCustomTimeZoneInfo(value: TimeZone)Sets the custom time zone info value.

See Also