HtmlSaveOptions (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.SaveOptions
- - com.aspose.cells.HtmlSaveOptions

Direct Known Subclasses:

EbookSaveOptions
```
public class HtmlSaveOptions
extends SaveOptions
```
Represents the options for saving html file.

Constructor Summary

Constructors
Constructor and Description

HtmlSaveOptions()
Creates options for saving html file.

HtmlSaveOptions(int saveFormat)
Creates options for saving htm file.

Constructors
Constructor and Description
`HtmlSaveOptions()` Creates options for saving html file.
`HtmlSaveOptions(int saveFormat)` Creates options for saving htm file.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`getAddGenericFont()` Indicates whether to add a generic font to CSS font-family.
`boolean`	`getAddTooltipText()` Indicates whether adding tooltip text when the data can't be fully displayed.
`java.lang.String`	`getAttachedFilesDirectory()` The directory that the attached files will be saved to.
`java.lang.String`	`getAttachedFilesUrlPrefix()` Specify the Url prefix of attached files such as image in the html file.
`boolean`	`getCalculateFormula()` Indicates whether to calculate formulas before saving html file.
`java.lang.String`	`getCellCssPrefix()` Gets the prefix of the css name,the default value is "".
`java.lang.String`	`getCellNameAttribute()` Specifies the attribute that indicates the CellName to be written.
`java.lang.String`	`getCssStyles()` Gets the additional css styles for the formatter.
`java.lang.String`	`getDefaultFontName()` Specify the default font name for exporting html, the default font will be used when the font of style is not existing, If this property is null, Aspose.Cells will use universal font which have the same family with the original font, the default value is null.
`boolean`	`getDisableCss()` Indicates whether only inline styles are applied, without relying on CSS.
`boolean`	`getDisableDownlevelRevealedComments()` Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
`int`	`getEmbeddedFontType()` Gets the type of font that embedded in html.
`boolean`	`getEnableCssCustomProperties()` Optimize the output of html by using CSS custom properties.
`boolean`	`getEncodeEntityAsCode()` Indicates whether the html character entities are replaced with decimal code.
`Encoding`	`getEncoding()` If not set,use Encoding.UTF8 as default enconding type.
`boolean`	`getExcludeUnusedStyles()` Indicating whether excludes unused styles.
`boolean`	`getExportActiveWorksheetOnly()` Indicates if only exporting the active worksheet to html file.
`CellArea`	`getExportArea()` Gets the exporting CellArea of current active Worksheet.
`boolean`	`getExportBogusRowData()` Indicating whether exporting bogus bottom row data.
`boolean`	`getExportCellCoordinate()` Indicates whether exporting excel coordinate of nonblank cells when saving file to html.
`int`	`getExportCommentsType()` Represents type of exporting comments to html files.
`int`	`getExportDataOptions()` Indicating the rule of exporting html file data.The default value is All.
`boolean`	`getExportDocumentProperties()` Indicating whether exporting document properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.
`boolean`	`getExportExtraHeadings()` Indicates whether exporting extra headings when the length of text is longer than max display column.
`boolean`	`getExportFormula()` Indicates whether exporting formula when saving file to html.
`boolean`	`getExportFrameScriptsAndProperties()` Indicating whether exporting frame scripts and document properties.
`boolean`	`getExportGridLines()` Indicating whether exporting the gridlines.The default value is false.
`boolean`	`getExportHeadings()` Deprecated. Use HtmlSaveOptions.ExportRowColumnHeadings instead.
`boolean`	`getExportHiddenWorksheet()` Indicating if exporting the hidden worksheet content.The default value is true.
`boolean`	`getExportImagesAsBase64()` Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
`IExportObjectListener`	`getExportObjectListener()` Deprecated. Use HtmlSaveOptions.IStreamProvider property instead.
`boolean`	`getExportPageFooters()` Indicates whether exporting page headers.
`boolean`	`getExportPageHeaders()` Indicates whether exporting page headers.
`boolean`	`getExportPrintAreaOnly()` Indicates if only exporting the print area to html file.
`boolean`	`getExportRowColumnHeadings()` Indicates whether exports sheet's row and column headings when saving to HTML files.
`boolean`	`getExportSimilarBorderStyle()` Indicating whether exporting the similar border style when the border style is not supported by browsers.
`boolean`	`getExportSingleTab()` Indicates whether exporting the single tab when the file only has one worksheet.
`boolean`	`getExportWorkbookProperties()` Indicating whether exporting workbook properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.
`boolean`	`getExportWorksheetCSSSeparately()` Indicating whether export the worksheet css separately.The default value is false.
`boolean`	`getExportWorksheetProperties()` Indicating whether exporting worksheet properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.
`IFilePathProvider`	`getFilePathProvider()` Gets the IFilePathProvider for exporting Worksheet to html separately.
`boolean`	`getFormatDataIgnoreColumnWidth()` Indicating whether show the whole formatted data of cell when overflowing the column.
`int`	`getHiddenColDisplayType()` Hidden column(the width of this column is 0) in excel,before save this into html format, if HtmlHiddenColDisplayType is "Remove",the hidden column would not been output, if the value is "Hidden", the column would been output,but was hidden,the default value is "Hidden"
`int`	`getHiddenRowDisplayType()` Hidden row(the height of this row is 0) in excel,before save this into html format, if HtmlHiddenRowDisplayType is "Remove",the hidden row would not been output, if the value is "Hidden", the row would been output,but was hidden,the default value is "Hidden"
`boolean`	`getHideOverflowWrappedText()` Indicates whether to hide overflow text when the cell format is set to wrap text.
`int`	`getHtmlCrossStringType()` Indicates if a cross-cell string will be displayed in the same way as MS Excel when saving an Excel file in html format.
`int`	`getHtmlVersion()` Specifies version of HTML standard that should be used when saving the HTML format.
`boolean`	`getIgnoreInvisibleShapes()` Indicate whether exporting those not visible shapes
`ImageOrPrintOptions`	`getImageOptions()` Get the ImageOrPrintOptions object before exporting
`boolean`	`getImageScalable()` Indicates whether using scalable unit to describe the image width when using scalable unit to describe the column width.
`int`	`getLinkTargetType()` Indicating the type of target attribute in `<a>` link.
`boolean`	`getMergeEmptyTdForcely()` Deprecated. Use HtmlSaveOptions.MergeEmptyTdType instead.
`int`	`getMergeEmptyTdType()` The option to merge contiguous empty cells(empty td elements) The default value is MergeEmptyTdType.Default.
`int`	`getOfficeMathOutputMode()` Indicates how export OfficeMath objects to HTML, Default value is Image.
`java.lang.String`	`getPageTitle()` The title of the html page.
`boolean`	`getParseHtmlTagInCell()` Indicates whether html tag(such as `<div></div>`) in cell should be parsed as cell value or preserved as it is.
`boolean`	`getPresentationPreference()` Indicating if html or mht file is presentation preference.
`boolean`	`getSaveAsSingleFile()` Indicates whether save the html as single file.
`SheetSet`	`getSheetSet()` Gets the sheets to render.
`boolean`	`getShowAllSheets()` Indicates whether showing all sheets when saving as a single html file.
`IStreamProvider`	`getStreamProvider()` Gets the IStreamProvider for exporting objects.
`java.lang.String`	`getTableCssId()` Gets the prefix of the type css name such as tr,col,td and so on, they are contained in the table element which has the specific TableCssId attribute.
`boolean`	`getWidthScalable()` Indicates whether exporting column width in unit of scale to html.
`boolean`	`getWorksheetScalable()` Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.
`boolean`	`isBorderCollapsed()` Indicates whether the table borders are collapsed.
`boolean`	`isExpImageToTempDir()` Indicates whether exporting image files to temp directory.
`boolean`	`isExportComments()` Indicates if exporting comments when saving file to html, the default value is false.
`boolean`	`isFullPathLink()` Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm.
`boolean`	`isIECompatible()` Indicating whether the output HTML is compatible with IE browser.
`boolean`	`isJsBrowserCompatible()` Indicates whether JavaScript is compatible with browsers that do not support JavaScript.
`boolean`	`isMobileCompatible()` Indicates whether the output HTML is compatible with mobile devices.
`void`	`setAddGenericFont(boolean value)` Indicates whether to add a generic font to CSS font-family.
`void`	`setAddTooltipText(boolean value)` Indicates whether adding tooltip text when the data can't be fully displayed.
`void`	`setAttachedFilesDirectory(java.lang.String value)` The directory that the attached files will be saved to.
`void`	`setAttachedFilesUrlPrefix(java.lang.String value)` Specify the Url prefix of attached files such as image in the html file.
`void`	`setBorderCollapsed(boolean value)` Indicates whether the table borders are collapsed.
`void`	`setCalculateFormula(boolean value)` Indicates whether to calculate formulas before saving html file.
`void`	`setCellCssPrefix(java.lang.String value)` Sets the prefix of the css name,the default value is "".
`void`	`setCellNameAttribute(java.lang.String value)` Specifies the attribute that indicates the CellName to be written.
`void`	`setCssStyles(java.lang.String value)` Sets the additional css styles for the formatter.
`void`	`setDefaultFontName(java.lang.String value)` Specify the default font name for exporting html, the default font will be used when the font of style is not existing, If this property is null, Aspose.Cells will use universal font which have the same family with the original font, the default value is null.
`void`	`setDisableCss(boolean value)` Indicates whether only inline styles are applied, without relying on CSS.
`void`	`setDisableDownlevelRevealedComments(boolean value)` Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
`void`	`setEmbeddedFontType(int value)` Sets the type of font that embedded in html.
`void`	`setEnableCssCustomProperties(boolean value)` Optimize the output of html by using CSS custom properties.
`void`	`setEncodeEntityAsCode(boolean value)` Indicates whether the html character entities are replaced with decimal code.
`void`	`setEncoding(Encoding value)` If not set,use Encoding.UTF8 as default enconding type.
`void`	`setExcludeUnusedStyles(boolean value)` Indicating whether excludes unused styles.
`void`	`setExpImageToTempDir(boolean value)` Indicates whether exporting image files to temp directory.
`void`	`setExportActiveWorksheetOnly(boolean value)` Indicates if only exporting the active worksheet to html file.
`void`	`setExportArea(CellArea value)` Sets the exporting CellArea of current active Worksheet.
`void`	`setExportBogusRowData(boolean value)` Indicating whether exporting bogus bottom row data.
`void`	`setExportCellCoordinate(boolean value)` Indicates whether exporting excel coordinate of nonblank cells when saving file to html.
`void`	`setExportComments(boolean value)` Indicates if exporting comments when saving file to html, the default value is false.
`void`	`setExportCommentsType(int value)` Represents type of exporting comments to html files.
`void`	`setExportDataOptions(int value)` Indicating the rule of exporting html file data.The default value is All.
`void`	`setExportDocumentProperties(boolean value)` Indicating whether exporting document properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.
`void`	`setExportExtraHeadings(boolean value)` Indicates whether exporting extra headings when the length of text is longer than max display column.
`void`	`setExportFormula(boolean value)` Indicates whether exporting formula when saving file to html.
`void`	`setExportFrameScriptsAndProperties(boolean value)` Indicating whether exporting frame scripts and document properties.
`void`	`setExportGridLines(boolean value)` Indicating whether exporting the gridlines.The default value is false.
`void`	`setExportHeadings(boolean value)` Deprecated. Use HtmlSaveOptions.ExportRowColumnHeadings instead.
`void`	`setExportHiddenWorksheet(boolean value)` Indicating if exporting the hidden worksheet content.The default value is true.
`void`	`setExportImagesAsBase64(boolean value)` Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
`void`	`setExportObjectListener(IExportObjectListener value)` Deprecated. Use HtmlSaveOptions.IStreamProvider property instead.
`void`	`setExportPageFooters(boolean value)` Indicates whether exporting page headers.
`void`	`setExportPageHeaders(boolean value)` Indicates whether exporting page headers.
`void`	`setExportPrintAreaOnly(boolean value)` Indicates if only exporting the print area to html file.
`void`	`setExportRowColumnHeadings(boolean value)` Indicates whether exports sheet's row and column headings when saving to HTML files.
`void`	`setExportSimilarBorderStyle(boolean value)` Indicating whether exporting the similar border style when the border style is not supported by browsers.
`void`	`setExportSingleTab(boolean value)` Indicates whether exporting the single tab when the file only has one worksheet.
`void`	`setExportWorkbookProperties(boolean value)` Indicating whether exporting workbook properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.
`void`	`setExportWorksheetCSSSeparately(boolean value)` Indicating whether export the worksheet css separately.The default value is false.
`void`	`setExportWorksheetProperties(boolean value)` Indicating whether exporting worksheet properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.
`void`	`setFilePathProvider(IFilePathProvider value)` Sets the IFilePathProvider for exporting Worksheet to html separately.
`void`	`setFormatDataIgnoreColumnWidth(boolean value)` Indicating whether show the whole formatted data of cell when overflowing the column.
`void`	`setFullPathLink(boolean value)` Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm.
`void`	`setHiddenColDisplayType(int value)` Hidden column(the width of this column is 0) in excel,before save this into html format, if HtmlHiddenColDisplayType is "Remove",the hidden column would not been output, if the value is "Hidden", the column would been output,but was hidden,the default value is "Hidden"
`void`	`setHiddenRowDisplayType(int value)` Hidden row(the height of this row is 0) in excel,before save this into html format, if HtmlHiddenRowDisplayType is "Remove",the hidden row would not been output, if the value is "Hidden", the row would been output,but was hidden,the default value is "Hidden"
`void`	`setHideOverflowWrappedText(boolean value)` Indicates whether to hide overflow text when the cell format is set to wrap text.
`void`	`setHtmlCrossStringType(int value)` Indicates if a cross-cell string will be displayed in the same way as MS Excel when saving an Excel file in html format.
`void`	`setHtmlVersion(int value)` Specifies version of HTML standard that should be used when saving the HTML format.
`void`	`setIECompatible(boolean value)` Indicating whether the output HTML is compatible with IE browser.
`void`	`setIgnoreInvisibleShapes(boolean value)` Indicate whether exporting those not visible shapes
`void`	`setImageScalable(boolean value)` Indicates whether using scalable unit to describe the image width when using scalable unit to describe the column width.
`void`	`setJsBrowserCompatible(boolean value)` Indicates whether JavaScript is compatible with browsers that do not support JavaScript.
`void`	`setLinkTargetType(int value)` Indicating the type of target attribute in `<a>` link.
`void`	`setMergeEmptyTdForcely(boolean value)` Deprecated. Use HtmlSaveOptions.MergeEmptyTdType instead.
`void`	`setMergeEmptyTdType(int value)` The option to merge contiguous empty cells(empty td elements) The default value is MergeEmptyTdType.Default.
`void`	`setMobileCompatible(boolean value)` Indicates whether the output HTML is compatible with mobile devices.
`void`	`setOfficeMathOutputMode(int value)` Indicates how export OfficeMath objects to HTML, Default value is Image.
`void`	`setPageTitle(java.lang.String value)` The title of the html page.
`void`	`setParseHtmlTagInCell(boolean value)` Indicates whether html tag(such as `<div></div>`) in cell should be parsed as cell value or preserved as it is.
`void`	`setPresentationPreference(boolean value)` Indicating if html or mht file is presentation preference.
`void`	`setSaveAsSingleFile(boolean value)` Indicates whether save the html as single file.
`void`	`setSheetSet(SheetSet value)` Sets the sheets to render.
`void`	`setShowAllSheets(boolean value)` Indicates whether showing all sheets when saving as a single html file.
`void`	`setStreamProvider(IStreamProvider value)` Sets the IStreamProvider for exporting objects.
`void`	`setTableCssId(java.lang.String value)` Sets the prefix of the type css name such as tr,col,td and so on, they are contained in the table element which has the specific TableCssId attribute.
`void`	`setWidthScalable(boolean value)` Indicates whether exporting column width in unit of scale to html.
`void`	`setWorksheetScalable(boolean value)` Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HtmlSaveOptions
```
public HtmlSaveOptions()
```
    Creates options for saving html file.
  - HtmlSaveOptions
```
public HtmlSaveOptions(int saveFormat)
```
    Creates options for saving htm file.
    
    Parameters:
    saveFormat - SaveFormat. The file format. It should be one of following types: SaveFormat.HTML or SaveFormat.M_HTML, otherwise the saved format will be set as SaveFormat.HTML automatically.
- Method Detail
  - getIgnoreInvisibleShapes
```
public boolean getIgnoreInvisibleShapes()
```
    Indicate whether exporting those not visible shapes
    Remarks
    The default values is false.
  - setIgnoreInvisibleShapes
```
public void setIgnoreInvisibleShapes(boolean value)
```
    Indicate whether exporting those not visible shapes
    Remarks
    The default values is false.
  - getPageTitle
```
public java.lang.String getPageTitle()
```
    The title of the html page. Only for saving to html stream.
  - setPageTitle
```
public void setPageTitle(java.lang.String value)
```
    The title of the html page. Only for saving to html stream.
  - getAttachedFilesDirectory
```
public java.lang.String getAttachedFilesDirectory()
```
    The directory that the attached files will be saved to. Only for saving to html stream.
  - setAttachedFilesDirectory
```
public void setAttachedFilesDirectory(java.lang.String value)
```
    The directory that the attached files will be saved to. Only for saving to html stream.
  - getAttachedFilesUrlPrefix
```
public java.lang.String getAttachedFilesUrlPrefix()
```
    Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.
  - setAttachedFilesUrlPrefix
```
public void setAttachedFilesUrlPrefix(java.lang.String value)
```
    Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.
  - getDefaultFontName
```
public java.lang.String getDefaultFontName()
```
    Specify the default font name for exporting html, the default font will be used when the font of style is not existing, If this property is null, Aspose.Cells will use universal font which have the same family with the original font, the default value is null.
  - setDefaultFontName
```
public void setDefaultFontName(java.lang.String value)
```
    Specify the default font name for exporting html, the default font will be used when the font of style is not existing, If this property is null, Aspose.Cells will use universal font which have the same family with the original font, the default value is null.
  - getAddGenericFont
```
public boolean getAddGenericFont()
```
    Indicates whether to add a generic font to CSS font-family. The default value is true
  - setAddGenericFont
```
public void setAddGenericFont(boolean value)
```
    Indicates whether to add a generic font to CSS font-family. The default value is true
  - getWorksheetScalable
```
public boolean getWorksheetScalable()
```
    Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.
  - setWorksheetScalable
```
public void setWorksheetScalable(boolean value)
```
    Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.
  - isExportComments
```
public boolean isExportComments()
```
    Indicates if exporting comments when saving file to html, the default value is false.
  - setExportComments
```
public void setExportComments(boolean value)
```
    Indicates if exporting comments when saving file to html, the default value is false.
  - getExportCommentsType
```
public int getExportCommentsType()
```
    Represents type of exporting comments to html files.
    See PrintCommentsType.
  - setExportCommentsType
```
public void setExportCommentsType(int value)
```
    Represents type of exporting comments to html files.
    See PrintCommentsType.
  - getDisableDownlevelRevealedComments
```
public boolean getDisableDownlevelRevealedComments()
```
    Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
  - setDisableDownlevelRevealedComments
```
public void setDisableDownlevelRevealedComments(boolean value)
```
    Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
  - isExpImageToTempDir
```
public boolean isExpImageToTempDir()
```
    Indicates whether exporting image files to temp directory. Only for saving to html stream.
  - setExpImageToTempDir
```
public void setExpImageToTempDir(boolean value)
```
    Indicates whether exporting image files to temp directory. Only for saving to html stream.
  - getImageScalable
```
public boolean getImageScalable()
```
    Indicates whether using scalable unit to describe the image width when using scalable unit to describe the column width. The default value is true.
  - setImageScalable
```
public void setImageScalable(boolean value)
```
    Indicates whether using scalable unit to describe the image width when using scalable unit to describe the column width. The default value is true.
  - getWidthScalable
```
public boolean getWidthScalable()
```
    Indicates whether exporting column width in unit of scale to html. The default value is false.
  - setWidthScalable
```
public void setWidthScalable(boolean value)
```
    Indicates whether exporting column width in unit of scale to html. The default value is false.
  - getExportSingleTab
```
public boolean getExportSingleTab()
```
    Indicates whether exporting the single tab when the file only has one worksheet. The default value is false.
  - setExportSingleTab
```
public void setExportSingleTab(boolean value)
```
    Indicates whether exporting the single tab when the file only has one worksheet. The default value is false.
  - getExportImagesAsBase64
```
public boolean getExportImagesAsBase64()
```
    Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
    Remarks
    When this property is set to true image data is exported directly on the img elements and separate files are not created.
  - setExportImagesAsBase64
```
public void setExportImagesAsBase64(boolean value)
```
    Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
    Remarks
    When this property is set to true image data is exported directly on the img elements and separate files are not created.
  - getExportActiveWorksheetOnly
```
public boolean getExportActiveWorksheetOnly()
```
    Indicates if only exporting the active worksheet to html file. If true then only the active worksheet will be exported to html file; If false then the whole workbook will be exported to html file. The default value is false.
  - setExportActiveWorksheetOnly
```
public void setExportActiveWorksheetOnly(boolean value)
```
    Indicates if only exporting the active worksheet to html file. If true then only the active worksheet will be exported to html file; If false then the whole workbook will be exported to html file. The default value is false.
  - getExportPrintAreaOnly
```
public boolean getExportPrintAreaOnly()
```
    Indicates if only exporting the print area to html file. The default value is false.
  - setExportPrintAreaOnly
```
public void setExportPrintAreaOnly(boolean value)
```
    Indicates if only exporting the print area to html file. The default value is false.
  - getExportArea
```
public CellArea getExportArea()
```
    Gets the exporting CellArea of current active Worksheet. If you set this attribute, the print area of current active Worksheet will be omitted. Only the specified area will be exported when saving the file to html.
  - setExportArea
```
public void setExportArea(CellArea value)
```
    Sets the exporting CellArea of current active Worksheet. If you set this attribute, the print area of current active Worksheet will be omitted. Only the specified area will be exported when saving the file to html.
  - getParseHtmlTagInCell
```
public boolean getParseHtmlTagInCell()
```
    Indicates whether html tag(such as <div></div>) in cell should be parsed as cell value or preserved as it is. The default value is true.
  - setParseHtmlTagInCell
```
public void setParseHtmlTagInCell(boolean value)
```
    Indicates whether html tag(such as <div></div>) in cell should be parsed as cell value or preserved as it is. The default value is true.
  - getHtmlCrossStringType
```
public int getHtmlCrossStringType()
```
    Indicates if a cross-cell string will be displayed in the same way as MS Excel when saving an Excel file in html format. By default the value is Default, so, for cross-cell strings, there is little difference between the html files created by Aspose.Cells and MS Excel. But the performance for creating large html files,setting the value to Cross would be several times faster than setting it to Default or Fit2Cell.
    See HtmlCrossType.
  - setHtmlCrossStringType
```
public void setHtmlCrossStringType(int value)
```
    Indicates if a cross-cell string will be displayed in the same way as MS Excel when saving an Excel file in html format. By default the value is Default, so, for cross-cell strings, there is little difference between the html files created by Aspose.Cells and MS Excel. But the performance for creating large html files,setting the value to Cross would be several times faster than setting it to Default or Fit2Cell.
    See HtmlCrossType.
  - getHiddenColDisplayType
```
public int getHiddenColDisplayType()
```
    Hidden column(the width of this column is 0) in excel,before save this into html format, if HtmlHiddenColDisplayType is "Remove",the hidden column would not been output, if the value is "Hidden", the column would been output,but was hidden,the default value is "Hidden"
    See HtmlHiddenColDisplayType.
  - setHiddenColDisplayType
```
public void setHiddenColDisplayType(int value)
```
    Hidden column(the width of this column is 0) in excel,before save this into html format, if HtmlHiddenColDisplayType is "Remove",the hidden column would not been output, if the value is "Hidden", the column would been output,but was hidden,the default value is "Hidden"
    See HtmlHiddenColDisplayType.
  - getHiddenRowDisplayType
```
public int getHiddenRowDisplayType()
```
    Hidden row(the height of this row is 0) in excel,before save this into html format, if HtmlHiddenRowDisplayType is "Remove",the hidden row would not been output, if the value is "Hidden", the row would been output,but was hidden,the default value is "Hidden"
    See HtmlHiddenRowDisplayType.
  - setHiddenRowDisplayType
```
public void setHiddenRowDisplayType(int value)
```
    Hidden row(the height of this row is 0) in excel,before save this into html format, if HtmlHiddenRowDisplayType is "Remove",the hidden row would not been output, if the value is "Hidden", the row would been output,but was hidden,the default value is "Hidden"
    See HtmlHiddenRowDisplayType.
  - getEncoding
```
public Encoding getEncoding()
```
    If not set,use Encoding.UTF8 as default enconding type.
  - setEncoding
```
public void setEncoding(Encoding value)
```
    If not set,use Encoding.UTF8 as default enconding type.
  - getExportObjectListener
```
public IExportObjectListener getExportObjectListener()
```
    Deprecated. Use HtmlSaveOptions.IStreamProvider property instead.
    
    Gets the ExportObjectListener for exporting objects.
    Remarks
    NOTE: This property is now obsolete. Instead, please use HtmlSaveOptions.IStreamProvider property. This property will be removed 12 months later since August 2015. Aspose apologizes for any inconvenience you may have experienced.
  - setExportObjectListener
```
public void setExportObjectListener(IExportObjectListener value)
```
    Deprecated. Use HtmlSaveOptions.IStreamProvider property instead.
    
    Sets the ExportObjectListener for exporting objects.
    Remarks
    NOTE: This property is now obsolete. Instead, please use HtmlSaveOptions.IStreamProvider property. This property will be removed 12 months later since August 2015. Aspose apologizes for any inconvenience you may have experienced.
  - getFilePathProvider
```
public IFilePathProvider getFilePathProvider()
```
    Gets the IFilePathProvider for exporting Worksheet to html separately.
  - setFilePathProvider
```
public void setFilePathProvider(IFilePathProvider value)
```
    Sets the IFilePathProvider for exporting Worksheet to html separately.
  - getStreamProvider
```
public IStreamProvider getStreamProvider()
```
    Gets the IStreamProvider for exporting objects.
  - setStreamProvider
```
public void setStreamProvider(IStreamProvider value)
```
    Sets the IStreamProvider for exporting objects.
  - getImageOptions
```
public ImageOrPrintOptions getImageOptions()
```
    Get the ImageOrPrintOptions object before exporting
  - getSaveAsSingleFile
```
public boolean getSaveAsSingleFile()
```
    Indicates whether save the html as single file. The default value is false.
    Remarks
    If there are multiple worksheets or other required resources such as pictures in the workbook, commonly those worksheets and other resources need to be saved into separate files. For some scenarios, user maybe need to get only one resultant file such as for the convenience of transferring. If so, user may set this property as true.
  - setSaveAsSingleFile
```
public void setSaveAsSingleFile(boolean value)
```
    Indicates whether save the html as single file. The default value is false.
    Remarks
    If there are multiple worksheets or other required resources such as pictures in the workbook, commonly those worksheets and other resources need to be saved into separate files. For some scenarios, user maybe need to get only one resultant file such as for the convenience of transferring. If so, user may set this property as true.
  - getShowAllSheets
```
public boolean getShowAllSheets()
```
    Indicates whether showing all sheets when saving as a single html file.
    Remarks
    Only works when getSaveAsSingleFile() is True.
  - setShowAllSheets
```
public void setShowAllSheets(boolean value)
```
    Indicates whether showing all sheets when saving as a single html file.
    Remarks
    Only works when getSaveAsSingleFile() is True.
  - getExportPageHeaders
```
public boolean getExportPageHeaders()
```
    Indicates whether exporting page headers.
    Remarks
    Only works when getSaveAsSingleFile() is True.
  - setExportPageHeaders
```
public void setExportPageHeaders(boolean value)
```
    Indicates whether exporting page headers.
    Remarks
    Only works when getSaveAsSingleFile() is True.
  - getExportPageFooters
```
public boolean getExportPageFooters()
```
    Indicates whether exporting page headers.
    Remarks
    Only works when getSaveAsSingleFile() is True.
  - setExportPageFooters
```
public void setExportPageFooters(boolean value)
```
    Indicates whether exporting page headers.
    Remarks
    Only works when getSaveAsSingleFile() is True.
  - getExportHiddenWorksheet
```
public boolean getExportHiddenWorksheet()
```
    Indicating if exporting the hidden worksheet content.The default value is true.
  - setExportHiddenWorksheet
```
public void setExportHiddenWorksheet(boolean value)
```
    Indicating if exporting the hidden worksheet content.The default value is true.
  - getPresentationPreference
```
public boolean getPresentationPreference()
```
    Indicating if html or mht file is presentation preference. The default value is false. if you want to get more beautiful presentation,please set the value to true.
  - setPresentationPreference
```
public void setPresentationPreference(boolean value)
```
    Indicating if html or mht file is presentation preference. The default value is false. if you want to get more beautiful presentation,please set the value to true.
  - getCellCssPrefix
```
public java.lang.String getCellCssPrefix()
```
    Gets the prefix of the css name,the default value is "".
  - setCellCssPrefix
```
public void setCellCssPrefix(java.lang.String value)
```
    Sets the prefix of the css name,the default value is "".
  - getTableCssId
```
public java.lang.String getTableCssId()
```
    Gets the prefix of the type css name such as tr,col,td and so on, they are contained in the table element which has the specific TableCssId attribute. The default value is "".
  - setTableCssId
```
public void setTableCssId(java.lang.String value)
```
    Sets the prefix of the type css name such as tr,col,td and so on, they are contained in the table element which has the specific TableCssId attribute. The default value is "".
  - isFullPathLink
```
public boolean isFullPathLink()
```
    Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false.
  - setFullPathLink
```
public void setFullPathLink(boolean value)
```
    Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false.
  - getExportWorksheetCSSSeparately
```
public boolean getExportWorksheetCSSSeparately()
```
    Indicating whether export the worksheet css separately.The default value is false.
  - setExportWorksheetCSSSeparately
```
public void setExportWorksheetCSSSeparately(boolean value)
```
    Indicating whether export the worksheet css separately.The default value is false.
  - getExportSimilarBorderStyle
```
public boolean getExportSimilarBorderStyle()
```
    Indicating whether exporting the similar border style when the border style is not supported by browsers. If you want to import the html or mht file to excel, please keep the default value. The default value is false.
  - setExportSimilarBorderStyle
```
public void setExportSimilarBorderStyle(boolean value)
```
    Indicating whether exporting the similar border style when the border style is not supported by browsers. If you want to import the html or mht file to excel, please keep the default value. The default value is false.
  - getMergeEmptyTdForcely
```
public boolean getMergeEmptyTdForcely()
```
    Deprecated. Use HtmlSaveOptions.MergeEmptyTdType instead.
    
    Indicates whether merging empty TD element forcedly when exporting file to html. The size of html file will be reduced significantly after setting value to true. The default value is false. If you want to import the html file to excel or export perfect grid lines when saving file to html, please keep the default value.
  - setMergeEmptyTdForcely
```
public void setMergeEmptyTdForcely(boolean value)
```
    Deprecated. Use HtmlSaveOptions.MergeEmptyTdType instead.
    
    Indicates whether merging empty TD element forcedly when exporting file to html. The size of html file will be reduced significantly after setting value to true. The default value is false. If you want to import the html file to excel or export perfect grid lines when saving file to html, please keep the default value.
  - getMergeEmptyTdType
```
public int getMergeEmptyTdType()
```
    The option to merge contiguous empty cells(empty td elements) The default value is MergeEmptyTdType.Default.
    See MergeEmptyTdType.
  - setMergeEmptyTdType
```
public void setMergeEmptyTdType(int value)
```
    The option to merge contiguous empty cells(empty td elements) The default value is MergeEmptyTdType.Default.
    See MergeEmptyTdType.
  - getExportCellCoordinate
```
public boolean getExportCellCoordinate()
```
    Indicates whether exporting excel coordinate of nonblank cells when saving file to html. The default value is false. If you want to import the output html to excel, please keep the default value.
  - setExportCellCoordinate
```
public void setExportCellCoordinate(boolean value)
```
    Indicates whether exporting excel coordinate of nonblank cells when saving file to html. The default value is false. If you want to import the output html to excel, please keep the default value.
  - getExportExtraHeadings
```
public boolean getExportExtraHeadings()
```
    Indicates whether exporting extra headings when the length of text is longer than max display column. The default value is false. If you want to import the html file to excel, please keep the default value.
  - setExportExtraHeadings
```
public void setExportExtraHeadings(boolean value)
```
    Indicates whether exporting extra headings when the length of text is longer than max display column. The default value is false. If you want to import the html file to excel, please keep the default value.
  - getExportHeadings
```
public boolean getExportHeadings()
```
    Deprecated. Use HtmlSaveOptions.ExportRowColumnHeadings instead.
    
    Indicates whether exports sheet's row and column headings when saving to HTML files.
    Remarks
    NOTE: This member is now obsolete. Instead, please use HtmlSaveOptions.ExportRowColumnHeadings property. This property will be removed 12 months later since June 2022. Aspose apologizes for any inconvenience you may have experienced.
  - setExportHeadings
```
public void setExportHeadings(boolean value)
```
    Deprecated. Use HtmlSaveOptions.ExportRowColumnHeadings instead.
    
    Indicates whether exports sheet's row and column headings when saving to HTML files.
    Remarks
    NOTE: This member is now obsolete. Instead, please use HtmlSaveOptions.ExportRowColumnHeadings property. This property will be removed 12 months later since June 2022. Aspose apologizes for any inconvenience you may have experienced.
  - getExportRowColumnHeadings
```
public boolean getExportRowColumnHeadings()
```
    Indicates whether exports sheet's row and column headings when saving to HTML files.
    Remarks
    The default value is false.
  - setExportRowColumnHeadings
```
public void setExportRowColumnHeadings(boolean value)
```
    Indicates whether exports sheet's row and column headings when saving to HTML files.
    Remarks
    The default value is false.
  - getExportFormula
```
public boolean getExportFormula()
```
    Indicates whether exporting formula when saving file to html. The default value is true. If you want to import the output html to excel, please keep the default value.
  - setExportFormula
```
public void setExportFormula(boolean value)
```
    Indicates whether exporting formula when saving file to html. The default value is true. If you want to import the output html to excel, please keep the default value.
  - getAddTooltipText
```
public boolean getAddTooltipText()
```
    Indicates whether adding tooltip text when the data can't be fully displayed. The default value is false.
  - setAddTooltipText
```
public void setAddTooltipText(boolean value)
```
    Indicates whether adding tooltip text when the data can't be fully displayed. The default value is false.
  - getExportGridLines
```
public boolean getExportGridLines()
```
    Indicating whether exporting the gridlines.The default value is false.
  - setExportGridLines
```
public void setExportGridLines(boolean value)
```
    Indicating whether exporting the gridlines.The default value is false.
  - getExportBogusRowData
```
public boolean getExportBogusRowData()
```
    Indicating whether exporting bogus bottom row data. The default value is true.If you want to import the html or mht file to excel, please keep the default value.
  - setExportBogusRowData
```
public void setExportBogusRowData(boolean value)
```
    Indicating whether exporting bogus bottom row data. The default value is true.If you want to import the html or mht file to excel, please keep the default value.
  - getExcludeUnusedStyles
```
public boolean getExcludeUnusedStyles()
```
    Indicating whether excludes unused styles. For the generated html files, excluding unused styles can make the file size smaller without affecting the visual effects. So the default value of this property is true. If user needs to keep all styles in the workbook for the generated html(such as the scenario that user needs to restore the workbook from the generated html later), please set this property as false.
  - setExcludeUnusedStyles
```
public void setExcludeUnusedStyles(boolean value)
```
    Indicating whether excludes unused styles. For the generated html files, excluding unused styles can make the file size smaller without affecting the visual effects. So the default value of this property is true. If user needs to keep all styles in the workbook for the generated html(such as the scenario that user needs to restore the workbook from the generated html later), please set this property as false.
  - getExportDocumentProperties
```
public boolean getExportDocumentProperties()
```
    Indicating whether exporting document properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.
  - setExportDocumentProperties
```
public void setExportDocumentProperties(boolean value)
```
    Indicating whether exporting document properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.
  - getExportWorksheetProperties
```
public boolean getExportWorksheetProperties()
```
    Indicating whether exporting worksheet properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.
  - setExportWorksheetProperties
```
public void setExportWorksheetProperties(boolean value)
```
    Indicating whether exporting worksheet properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.
  - getExportWorkbookProperties
```
public boolean getExportWorkbookProperties()
```
    Indicating whether exporting workbook properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.
  - setExportWorkbookProperties
```
public void setExportWorkbookProperties(boolean value)
```
    Indicating whether exporting workbook properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.
  - getExportFrameScriptsAndProperties
```
public boolean getExportFrameScriptsAndProperties()
```
    Indicating whether exporting frame scripts and document properties. The default value is true.If you want to import the html or mht file to excel, please keep the default value.
  - setExportFrameScriptsAndProperties
```
public void setExportFrameScriptsAndProperties(boolean value)
```
    Indicating whether exporting frame scripts and document properties. The default value is true.If you want to import the html or mht file to excel, please keep the default value.
  - getExportDataOptions
```
public int getExportDataOptions()
```
    Indicating the rule of exporting html file data.The default value is All.
    See HtmlExportDataOptions.
  - setExportDataOptions
```
public void setExportDataOptions(int value)
```
    Indicating the rule of exporting html file data.The default value is All.
    See HtmlExportDataOptions.
  - getLinkTargetType
```
public int getLinkTargetType()
```
    Indicating the type of target attribute in <a> link. The default value is HtmlLinkTargetType.Parent.
    See HtmlLinkTargetType.
  - setLinkTargetType
```
public void setLinkTargetType(int value)
```
    Indicating the type of target attribute in <a> link. The default value is HtmlLinkTargetType.Parent.
    See HtmlLinkTargetType.
  - isIECompatible
```
public boolean isIECompatible()
```
    Indicating whether the output HTML is compatible with IE browser. The defalut value is false
  - setIECompatible
```
public void setIECompatible(boolean value)
```
    Indicating whether the output HTML is compatible with IE browser. The defalut value is false
  - getFormatDataIgnoreColumnWidth
```
public boolean getFormatDataIgnoreColumnWidth()
```
    Indicating whether show the whole formatted data of cell when overflowing the column. If true then ignore the column width and the whole data of cell will be exported. If false then the data will be exported same as Excel. The default value is false.
  - setFormatDataIgnoreColumnWidth
```
public void setFormatDataIgnoreColumnWidth(boolean value)
```
    Indicating whether show the whole formatted data of cell when overflowing the column. If true then ignore the column width and the whole data of cell will be exported. If false then the data will be exported same as Excel. The default value is false.
  - getCalculateFormula
```
public boolean getCalculateFormula()
```
    Indicates whether to calculate formulas before saving html file.
    Remarks
    The default value is false.
  - setCalculateFormula
```
public void setCalculateFormula(boolean value)
```
    Indicates whether to calculate formulas before saving html file.
    Remarks
    The default value is false.
  - isJsBrowserCompatible
```
public boolean isJsBrowserCompatible()
```
    Indicates whether JavaScript is compatible with browsers that do not support JavaScript. The default value is true.
  - setJsBrowserCompatible
```
public void setJsBrowserCompatible(boolean value)
```
    Indicates whether JavaScript is compatible with browsers that do not support JavaScript. The default value is true.
  - isMobileCompatible
```
public boolean isMobileCompatible()
```
    Indicates whether the output HTML is compatible with mobile devices. The default value is false.
  - setMobileCompatible
```
public void setMobileCompatible(boolean value)
```
    Indicates whether the output HTML is compatible with mobile devices. The default value is false.
  - getCssStyles
```
public java.lang.String getCssStyles()
```
    Gets the additional css styles for the formatter. Only works when getSaveAsSingleFile() is True. CssStyles="body { padding: 5px }";
  - setCssStyles
```
public void setCssStyles(java.lang.String value)
```
    Sets the additional css styles for the formatter. Only works when getSaveAsSingleFile() is True. CssStyles="body { padding: 5px }";
  - getHideOverflowWrappedText
```
public boolean getHideOverflowWrappedText()
```
    Indicates whether to hide overflow text when the cell format is set to wrap text. The default value is false
  - setHideOverflowWrappedText
```
public void setHideOverflowWrappedText(boolean value)
```
    Indicates whether to hide overflow text when the cell format is set to wrap text. The default value is false
  - isBorderCollapsed
```
public boolean isBorderCollapsed()
```
    Indicates whether the table borders are collapsed. The default value is true.
  - setBorderCollapsed
```
public void setBorderCollapsed(boolean value)
```
    Indicates whether the table borders are collapsed. The default value is true.
  - getEncodeEntityAsCode
```
public boolean getEncodeEntityAsCode()
```
    Indicates whether the html character entities are replaced with decimal code. (e.g. " " is replaced with " "). The default value is false.
  - setEncodeEntityAsCode
```
public void setEncodeEntityAsCode(boolean value)
```
    Indicates whether the html character entities are replaced with decimal code. (e.g. " " is replaced with " "). The default value is false.
  - getOfficeMathOutputMode
```
public int getOfficeMathOutputMode()
```
    Indicates how export OfficeMath objects to HTML, Default value is Image.
    See HtmlOfficeMathOutputType.
  - setOfficeMathOutputMode
```
public void setOfficeMathOutputMode(int value)
```
    Indicates how export OfficeMath objects to HTML, Default value is Image.
    See HtmlOfficeMathOutputType.
  - getCellNameAttribute
```
public java.lang.String getCellNameAttribute()
```
    Specifies the attribute that indicates the CellName to be written. (e.g. If the value is "id", then for cell "A1", the output will be:<td id='A1'>). The default value is null.
  - setCellNameAttribute
```
public void setCellNameAttribute(java.lang.String value)
```
    Specifies the attribute that indicates the CellName to be written. (e.g. If the value is "id", then for cell "A1", the output will be:<td id='A1'>). The default value is null.
  - getDisableCss
```
public boolean getDisableCss()
```
    Indicates whether only inline styles are applied, without relying on CSS. The default value is false.
  - setDisableCss
```
public void setDisableCss(boolean value)
```
    Indicates whether only inline styles are applied, without relying on CSS. The default value is false.
  - getEnableCssCustomProperties
```
public boolean getEnableCssCustomProperties()
```
    Optimize the output of html by using CSS custom properties. For example, for the scenario that there are multiple occurences for one base64 image, with custom property the image data only needs to be saved once so the performance of the resultant html can be improved. The default value is false.
  - setEnableCssCustomProperties
```
public void setEnableCssCustomProperties(boolean value)
```
    Optimize the output of html by using CSS custom properties. For example, for the scenario that there are multiple occurences for one base64 image, with custom property the image data only needs to be saved once so the performance of the resultant html can be improved. The default value is false.
  - getHtmlVersion
```
public int getHtmlVersion()
```
    Specifies version of HTML standard that should be used when saving the HTML format. Default value is HtmlVersion.Default.
    See HtmlVersion.
  - setHtmlVersion
```
public void setHtmlVersion(int value)
```
    Specifies version of HTML standard that should be used when saving the HTML format. Default value is HtmlVersion.Default.
    See HtmlVersion.
  - getSheetSet
```
public SheetSet getSheetSet()
```
    Gets the sheets to render. Default is all visible sheets in the workbook: SheetSet.getVisible().
  - setSheetSet
```
public void setSheetSet(SheetSet value)
```
    Sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.getVisible().
  - getEmbeddedFontType
```
public int getEmbeddedFontType()
```
    Gets the type of font that embedded in html. Default value is HtmlEmbeddedFontType.NONE which indicates that it will not embed font in html.
    See HtmlEmbeddedFontType.
  - setEmbeddedFontType
```
public void setEmbeddedFontType(int value)
```
    Sets the type of font that embedded in html. Default value is HtmlEmbeddedFontType.NONE which indicates that it will not embed font in html.
    See HtmlEmbeddedFontType.

Class HtmlSaveOptions

Constructor Summary

Method Summary

Methods inherited from class com.aspose.cells.SaveOptions

Methods inherited from class java.lang.Object

Constructor Detail

HtmlSaveOptions

HtmlSaveOptions

Method Detail

getIgnoreInvisibleShapes

setIgnoreInvisibleShapes

getPageTitle

setPageTitle

getAttachedFilesDirectory

setAttachedFilesDirectory

getAttachedFilesUrlPrefix

setAttachedFilesUrlPrefix

getDefaultFontName

setDefaultFontName

getAddGenericFont

setAddGenericFont

getWorksheetScalable

setWorksheetScalable

isExportComments

setExportComments

getExportCommentsType

setExportCommentsType

getDisableDownlevelRevealedComments

setDisableDownlevelRevealedComments

isExpImageToTempDir

setExpImageToTempDir

getImageScalable

setImageScalable

getWidthScalable

setWidthScalable

getExportSingleTab

setExportSingleTab

getExportImagesAsBase64

setExportImagesAsBase64

getExportActiveWorksheetOnly

setExportActiveWorksheetOnly

getExportPrintAreaOnly

setExportPrintAreaOnly

getExportArea

setExportArea

getParseHtmlTagInCell

setParseHtmlTagInCell

getHtmlCrossStringType

setHtmlCrossStringType

getHiddenColDisplayType

setHiddenColDisplayType

getHiddenRowDisplayType

setHiddenRowDisplayType

getEncoding

setEncoding

getExportObjectListener

setExportObjectListener

getFilePathProvider

setFilePathProvider

getStreamProvider

setStreamProvider

getImageOptions

getSaveAsSingleFile

setSaveAsSingleFile

getShowAllSheets

setShowAllSheets

getExportPageHeaders

setExportPageHeaders

getExportPageFooters

setExportPageFooters

getExportHiddenWorksheet

setExportHiddenWorksheet

getPresentationPreference

setPresentationPreference

getCellCssPrefix

setCellCssPrefix

getTableCssId

setTableCssId

isFullPathLink

setFullPathLink