HtmlSaveOptions

HtmlSaveOptions class

Represents the options for saving html file.

class HtmlSaveOptions extends SaveOptions;

Constructors

Name	Description
constructor()	Creates options for saving html file.
constructor(SaveOptions)	Constructs from a parent object convertible to this.
constructor(SaveFormat)	Creates options for saving htm file.

Methods

Method	Description
getIgnoreInvisibleShapes()	Indicate whether exporting those not visible shapes
setIgnoreInvisibleShapes(boolean)	Indicate whether exporting those not visible shapes
getPageTitle()	The title of the html page. Only for saving to html stream.
setPageTitle(string)	The title of the html page. Only for saving to html stream.
getAttachedFilesDirectory()	The directory that the attached files will be saved to. Only for saving to html stream.
setAttachedFilesDirectory(string)	The directory that the attached files will be saved to. Only for saving to html stream.
getAttachedFilesUrlPrefix()	Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.
setAttachedFilesUrlPrefix(string)	Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.
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(string)	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()	Indicates whether to add a generic font to CSS font-family. The default value is true
setAddGenericFont(boolean)	Indicates whether to add a generic font to CSS font-family. The default value is true
getWorksheetScalable()	Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.
setWorksheetScalable(boolean)	Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.
isExportComments()	Indicates if exporting comments when saving file to html, the default value is false.
setIsExportComments(boolean)	Indicates if exporting comments when saving file to html, the default value is false.
getExportCommentsType()	Represents type of exporting comments to html files.
setExportCommentsType(PrintCommentsType)	Represents type of exporting comments to html files.
getDisableDownlevelRevealedComments()	Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
setDisableDownlevelRevealedComments(boolean)	Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
isExpImageToTempDir()	Indicates whether exporting image files to temp directory. Only for saving to html stream.
setIsExpImageToTempDir(boolean)	Indicates whether exporting image files to temp directory. Only for saving to html stream.
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(boolean)	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()	Indicates whether exporting column width in unit of scale to html. The default value is false.
setWidthScalable(boolean)	Indicates whether exporting column width in unit of scale to html. The default value is false.
getExportSingleTab()	Indicates whether exporting the single tab when the file only has one worksheet. The default value is false.
setExportSingleTab(boolean)	Indicates whether exporting the single tab when the file only has one worksheet. The default value is false.
getExportImagesAsBase64()	Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
setExportImagesAsBase64(boolean)	Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
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(boolean)	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()	Indicates if only exporting the print area to html file. The default value is false.
setExportPrintAreaOnly(boolean)	Indicates if only exporting the print area to html file. The default value is false.
getExportArea()	Gets or 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.
setExportArea(CellArea)	Gets or 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()	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(boolean)	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()	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.
setHtmlCrossStringType(HtmlCrossType)	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.
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”
setHiddenColDisplayType(HtmlHiddenColDisplayType)	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”
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”
setHiddenRowDisplayType(HtmlHiddenRowDisplayType)	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”
getEncoding()	If not set,use Encoding.UTF8 as default enconding type.
setEncoding(EncodingType)	If not set,use Encoding.UTF8 as default enconding type.
getFilePathProvider()	Gets or sets the IFilePathProvider for exporting Worksheet to html separately.
setFilePathProvider(IFilePathProvider)	Gets or sets the IFilePathProvider for exporting Worksheet to html separately.
getImageOptions()	Get the ImageOrPrintOptions object before exporting
getSaveAsSingleFile()	Indicates whether save the html as single file. The default value is false.
setSaveAsSingleFile(boolean)	Indicates whether save the html as single file. The default value is false.
getShowAllSheets()	Indicates whether showing all sheets when saving as a single html file.
setShowAllSheets(boolean)	Indicates whether showing all sheets when saving as a single html file.
getExportPageHeaders()	Indicates whether exporting page headers.
setExportPageHeaders(boolean)	Indicates whether exporting page headers.
getExportPageFooters()	Indicates whether exporting page headers.
setExportPageFooters(boolean)	Indicates whether exporting page headers.
getExportHiddenWorksheet()	Indicating if exporting the hidden worksheet content.The default value is true.
setExportHiddenWorksheet(boolean)	Indicating if exporting the hidden worksheet content.The default value is true.
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(boolean)	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()	Gets and sets the prefix of the css name,the default value is “”.
setCellCssPrefix(string)	Gets and sets the prefix of the css name,the default value is “”.
getTableCssId()	Gets and 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 “”.
setTableCssId(string)	Gets and 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()	Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false.
setIsFullPathLink(boolean)	Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false.
getExportWorksheetCSSSeparately()	Indicating whether export the worksheet css separately.The default value is false.
setExportWorksheetCSSSeparately(boolean)	Indicating whether export the worksheet css separately.The default value is false.
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(boolean)	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()	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(boolean)	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()	The option to merge contiguous empty cells(empty td elements) The default value is MergeEmptyTdType.Default.
setMergeEmptyTdType(MergeEmptyTdType)	The option to merge contiguous empty cells(empty td elements) The default value is MergeEmptyTdType.Default.
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(boolean)	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()	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(boolean)	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.
getExportRowColumnHeadings()	Indicates whether exports sheet’s row and column headings when saving to HTML files.
setExportRowColumnHeadings(boolean)	Indicates whether exports sheet’s row and column headings when saving to HTML files.
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(boolean)	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()	Indicates whether adding tooltip text when the data can’t be fully displayed. The default value is false.
setAddTooltipText(boolean)	Indicates whether adding tooltip text when the data can’t be fully displayed. The default value is false.
getExportGridLines()	Indicating whether exporting the gridlines.The default value is false.
setExportGridLines(boolean)	Indicating whether exporting the gridlines.The default value is false.
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(boolean)	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()	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(boolean)	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()	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(boolean)	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()	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(boolean)	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()	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(boolean)	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()	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(boolean)	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()	Indicating the rule of exporting html file data.The default value is All.
setExportDataOptions(HtmlExportDataOptions)	Indicating the rule of exporting html file data.The default value is All.
getLinkTargetType()	Indicating the type of target attribute in <a> link. The default value is HtmlLinkTargetType.Parent.
setLinkTargetType(HtmlLinkTargetType)	Indicating the type of target attribute in <a> link. The default value is HtmlLinkTargetType.Parent.
isIECompatible()	Indicating whether the output HTML is compatible with IE browser. The defalut value is false
setIsIECompatible(boolean)	Indicating whether the output HTML is compatible with IE browser. The defalut value is false
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(boolean)	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()	Indicates whether to calculate formulas before saving html file.
setCalculateFormula(boolean)	Indicates whether to calculate formulas before saving html file.
isJsBrowserCompatible()	Indicates whether JavaScript is compatible with browsers that do not support JavaScript. The default value is true.
setIsJsBrowserCompatible(boolean)	Indicates whether JavaScript is compatible with browsers that do not support JavaScript. The default value is true.
isMobileCompatible()	Indicates whether the output HTML is compatible with mobile devices. The default value is false.
setIsMobileCompatible(boolean)	Indicates whether the output HTML is compatible with mobile devices. The default value is false.
getCssStyles()	Gets or sets the additional css styles for the formatter. Only works when SaveAsSingleFile is True. CssStyles=“body { padding: 5px }”;
setCssStyles(string)	Gets or sets the additional css styles for the formatter. Only works when SaveAsSingleFile is True. CssStyles=“body { padding: 5px }”;
getHideOverflowWrappedText()	Indicates whether to hide overflow text when the cell format is set to wrap text. The default value is false
setHideOverflowWrappedText(boolean)	Indicates whether to hide overflow text when the cell format is set to wrap text. The default value is false
isBorderCollapsed()	Indicates whether the table borders are collapsed. The default value is true.
setIsBorderCollapsed(boolean)	Indicates whether the table borders are collapsed. The default value is true.
getSaveFormat()	Gets the save file format.
getClearData()	Make the workbook empty after saving the file.
setClearData(boolean)	Make the workbook empty after saving the file.
getCachedFileFolder()	The cached file folder is used to store some large data.
setCachedFileFolder(string)	The cached file folder is used to store some large data.
getValidateMergedAreas()	Indicates whether validate merged cells before saving the file.
setValidateMergedAreas(boolean)	Indicates whether validate merged cells before saving the file.
getMergeAreas()	Indicates whether merge the areas of conditional formatting and validation before saving the file.
setMergeAreas(boolean)	Indicates whether merge the areas of conditional formatting and validation before saving the file.
getCreateDirectory()	If true and the directory does not exist, the directory will be automatically created before saving the file.
setCreateDirectory(boolean)	If true and the directory does not exist, the directory will be automatically created before saving the file.
getSortNames()	Indicates whether sorting defined names before saving file.
setSortNames(boolean)	Indicates whether sorting defined names before saving file.
getSortExternalNames()	Indicates whether sorting external defined names before saving file.
setSortExternalNames(boolean)	Indicates whether sorting external defined names before saving file.
getRefreshChartCache()	Indicates whether refreshing chart cache data
setRefreshChartCache(boolean)	Indicates whether refreshing chart cache data
setWarningCallback(IWarningCallback)	Gets or sets warning callback.
getWarningCallback()	Gets or sets warning callback.
getUpdateSmartArt()	Indicates whether updating smart art setting. The default value is false.
setUpdateSmartArt(boolean)	Indicates whether updating smart art setting. The default value is false.

constructor()

Creates options for saving html file.

constructor();

constructor(SaveOptions)

Constructs from a parent object convertible to this.

constructor(obj: SaveOptions);

Parameters:

Parameter	Type	Description
obj	SaveOptions	The parent object.

constructor(SaveFormat)

Creates options for saving htm file.

constructor(saveFormat: SaveFormat);

Parameters:

Parameter	Type	Description
saveFormat	SaveFormat	The file format. /// It should be one of following types: SaveFormat.Html, SaveFormat.Html, /// or SaveFormat.Html, /// otherwise the saved format will be set as SaveFormat.Html automatically.

getIgnoreInvisibleShapes()

Indicate whether exporting those not visible shapes

getIgnoreInvisibleShapes() : boolean;

Remarks

The default values is false.

setIgnoreInvisibleShapes(boolean)

Indicate whether exporting those not visible shapes

setIgnoreInvisibleShapes(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

The default values is false.

getPageTitle()

The title of the html page. Only for saving to html stream.

getPageTitle() : string;

setPageTitle(string)

The title of the html page. Only for saving to html stream.

setPageTitle(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getAttachedFilesDirectory()

The directory that the attached files will be saved to. Only for saving to html stream.

getAttachedFilesDirectory() : string;

setAttachedFilesDirectory(string)

The directory that the attached files will be saved to. Only for saving to html stream.

setAttachedFilesDirectory(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getAttachedFilesUrlPrefix()

Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.

getAttachedFilesUrlPrefix() : string;

setAttachedFilesUrlPrefix(string)

Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.

setAttachedFilesUrlPrefix(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

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.

getDefaultFontName() : string;

setDefaultFontName(string)

setDefaultFontName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getAddGenericFont()

Indicates whether to add a generic font to CSS font-family. The default value is true

getAddGenericFont() : boolean;

setAddGenericFont(boolean)

Indicates whether to add a generic font to CSS font-family. The default value is true

setAddGenericFont(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getWorksheetScalable()

Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.

getWorksheetScalable() : boolean;

setWorksheetScalable(boolean)

Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.

setWorksheetScalable(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isExportComments()

Indicates if exporting comments when saving file to html, the default value is false.

isExportComments() : boolean;

setIsExportComments(boolean)

Indicates if exporting comments when saving file to html, the default value is false.

setIsExportComments(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getExportCommentsType()

Represents type of exporting comments to html files.

getExportCommentsType() : PrintCommentsType;

Returns

PrintCommentsType

setExportCommentsType(PrintCommentsType)

Represents type of exporting comments to html files.

setExportCommentsType(value: PrintCommentsType) : void;

Parameters:

Parameter	Type	Description
value	PrintCommentsType	The value to set.

getDisableDownlevelRevealedComments()

Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.

getDisableDownlevelRevealedComments() : boolean;

setDisableDownlevelRevealedComments(boolean)

Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.

setDisableDownlevelRevealedComments(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isExpImageToTempDir()

Indicates whether exporting image files to temp directory. Only for saving to html stream.

isExpImageToTempDir() : boolean;

setIsExpImageToTempDir(boolean)

Indicates whether exporting image files to temp directory. Only for saving to html stream.

setIsExpImageToTempDir(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

getImageScalable() : boolean;

setImageScalable(boolean)

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(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getWidthScalable()

Indicates whether exporting column width in unit of scale to html. The default value is false.

getWidthScalable() : boolean;

setWidthScalable(boolean)

Indicates whether exporting column width in unit of scale to html. The default value is false.

setWidthScalable(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getExportSingleTab()

Indicates whether exporting the single tab when the file only has one worksheet. The default value is false.

getExportSingleTab() : boolean;

setExportSingleTab(boolean)

Indicates whether exporting the single tab when the file only has one worksheet. The default value is false.

setExportSingleTab(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getExportImagesAsBase64()

Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.

getExportImagesAsBase64() : boolean;

Remarks

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

setExportImagesAsBase64(boolean)

Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.

setExportImagesAsBase64(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

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

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.

getExportActiveWorksheetOnly() : boolean;

setExportActiveWorksheetOnly(boolean)

setExportActiveWorksheetOnly(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getExportPrintAreaOnly()

Indicates if only exporting the print area to html file. The default value is false.

getExportPrintAreaOnly() : boolean;

setExportPrintAreaOnly(boolean)

Indicates if only exporting the print area to html file. The default value is false.

setExportPrintAreaOnly(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getExportArea()

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

getExportArea() : CellArea;

Returns

CellArea

setExportArea(CellArea)

setExportArea(value: CellArea) : void;

Parameters:

Parameter	Type	Description
value	CellArea	The value to set.

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.

getParseHtmlTagInCell() : boolean;

setParseHtmlTagInCell(boolean)

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(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

getHtmlCrossStringType() : HtmlCrossType;

Returns

HtmlCrossType

setHtmlCrossStringType(HtmlCrossType)

setHtmlCrossStringType(value: HtmlCrossType) : void;

Parameters:

Parameter	Type	Description
value	HtmlCrossType	The value to set.

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”

getHiddenColDisplayType() : HtmlHiddenColDisplayType;

Returns

HtmlHiddenColDisplayType

setHiddenColDisplayType(HtmlHiddenColDisplayType)

setHiddenColDisplayType(value: HtmlHiddenColDisplayType) : void;

Parameters:

Parameter	Type	Description
value	HtmlHiddenColDisplayType	The value to set.

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”

getHiddenRowDisplayType() : HtmlHiddenRowDisplayType;

Returns

HtmlHiddenRowDisplayType

setHiddenRowDisplayType(HtmlHiddenRowDisplayType)

setHiddenRowDisplayType(value: HtmlHiddenRowDisplayType) : void;

Parameters:

Parameter	Type	Description
value	HtmlHiddenRowDisplayType	The value to set.

getEncoding()

If not set,use Encoding.UTF8 as default enconding type.

getEncoding() : EncodingType;

Returns

EncodingType

setEncoding(EncodingType)

If not set,use Encoding.UTF8 as default enconding type.

setEncoding(value: EncodingType) : void;

Parameters:

Parameter	Type	Description
value	EncodingType	The value to set.

getFilePathProvider()

Gets or sets the IFilePathProvider for exporting Worksheet to html separately.

getFilePathProvider() : IFilePathProvider;

Returns

IFilePathProvider

setFilePathProvider(IFilePathProvider)

Gets or sets the IFilePathProvider for exporting Worksheet to html separately.

setFilePathProvider(value: IFilePathProvider) : void;

Parameters:

Parameter	Type	Description
value	IFilePathProvider	The value to set.

getImageOptions()

Get the ImageOrPrintOptions object before exporting

getImageOptions() : ImageOrPrintOptions;

Returns

ImageOrPrintOptions

getSaveAsSingleFile()

Indicates whether save the html as single file. The default value is false.

getSaveAsSingleFile() : boolean;

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(boolean)

Indicates whether save the html as single file. The default value is false.

setSaveAsSingleFile(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

getShowAllSheets()

Indicates whether showing all sheets when saving as a single html file.

getShowAllSheets() : boolean;

Remarks

Only works when SaveAsSingleFile is True.

setShowAllSheets(boolean)

Indicates whether showing all sheets when saving as a single html file.

setShowAllSheets(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only works when SaveAsSingleFile is True.

getExportPageHeaders()

Indicates whether exporting page headers.

getExportPageHeaders() : boolean;

Remarks

Only works when SaveAsSingleFile is True.

setExportPageHeaders(boolean)

Indicates whether exporting page headers.

setExportPageHeaders(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only works when SaveAsSingleFile is True.

getExportPageFooters()

Indicates whether exporting page headers.

getExportPageFooters() : boolean;

Remarks

Only works when SaveAsSingleFile is True.

setExportPageFooters(boolean)

Indicates whether exporting page headers.

setExportPageFooters(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only works when SaveAsSingleFile is True.

getExportHiddenWorksheet()

Indicating if exporting the hidden worksheet content.The default value is true.

getExportHiddenWorksheet() : boolean;

setExportHiddenWorksheet(boolean)

Indicating if exporting the hidden worksheet content.The default value is true.

setExportHiddenWorksheet(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

getPresentationPreference() : boolean;

setPresentationPreference(boolean)

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(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getCellCssPrefix()

Gets and sets the prefix of the css name,the default value is “”.

getCellCssPrefix() : string;

setCellCssPrefix(string)

Gets and sets the prefix of the css name,the default value is “”.

setCellCssPrefix(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getTableCssId()

Gets and 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 “”.

getTableCssId() : string;

setTableCssId(string)

Gets and 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 “”.

setTableCssId(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

isFullPathLink()

Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false.

isFullPathLink() : boolean;

setIsFullPathLink(boolean)

Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false.

setIsFullPathLink(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getExportWorksheetCSSSeparately()

Indicating whether export the worksheet css separately.The default value is false.

getExportWorksheetCSSSeparately() : boolean;

setExportWorksheetCSSSeparately(boolean)

Indicating whether export the worksheet css separately.The default value is false.

setExportWorksheetCSSSeparately(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

getExportSimilarBorderStyle() : boolean;

setExportSimilarBorderStyle(boolean)

setExportSimilarBorderStyle(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getMergeEmptyTdForcely()

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.

getMergeEmptyTdForcely() : boolean;

setMergeEmptyTdForcely(boolean)

setMergeEmptyTdForcely(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getMergeEmptyTdType()

The option to merge contiguous empty cells(empty td elements) The default value is MergeEmptyTdType.Default.

getMergeEmptyTdType() : MergeEmptyTdType;

Returns

MergeEmptyTdType

setMergeEmptyTdType(MergeEmptyTdType)

The option to merge contiguous empty cells(empty td elements) The default value is MergeEmptyTdType.Default.

setMergeEmptyTdType(value: MergeEmptyTdType) : void;

Parameters:

Parameter	Type	Description
value	MergeEmptyTdType	The value to set.

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.

getExportCellCoordinate() : boolean;

setExportCellCoordinate(boolean)

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(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

getExportExtraHeadings() : boolean;

setExportExtraHeadings(boolean)

setExportExtraHeadings(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getExportRowColumnHeadings()

Indicates whether exports sheet’s row and column headings when saving to HTML files.

getExportRowColumnHeadings() : boolean;

Remarks

The default value is false.

setExportRowColumnHeadings(boolean)

Indicates whether exports sheet’s row and column headings when saving to HTML files.

setExportRowColumnHeadings(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

The default value is false.

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.

getExportFormula() : boolean;

setExportFormula(boolean)

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(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getAddTooltipText()

Indicates whether adding tooltip text when the data can’t be fully displayed. The default value is false.

getAddTooltipText() : boolean;

setAddTooltipText(boolean)

Indicates whether adding tooltip text when the data can’t be fully displayed. The default value is false.

setAddTooltipText(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getExportGridLines()

Indicating whether exporting the gridlines.The default value is false.

getExportGridLines() : boolean;

setExportGridLines(boolean)

Indicating whether exporting the gridlines.The default value is false.

setExportGridLines(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

getExportBogusRowData() : boolean;

setExportBogusRowData(boolean)

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(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

getExcludeUnusedStyles() : boolean;

setExcludeUnusedStyles(boolean)

setExcludeUnusedStyles(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

getExportDocumentProperties() : boolean;

setExportDocumentProperties(boolean)

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(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

getExportWorksheetProperties() : boolean;

setExportWorksheetProperties(boolean)

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(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

getExportWorkbookProperties() : boolean;

setExportWorkbookProperties(boolean)

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(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

getExportFrameScriptsAndProperties() : boolean;

setExportFrameScriptsAndProperties(boolean)

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(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getExportDataOptions()

Indicating the rule of exporting html file data.The default value is All.

getExportDataOptions() : HtmlExportDataOptions;

Returns

HtmlExportDataOptions

setExportDataOptions(HtmlExportDataOptions)

Indicating the rule of exporting html file data.The default value is All.

setExportDataOptions(value: HtmlExportDataOptions) : void;

Parameters:

Parameter	Type	Description
value	HtmlExportDataOptions	The value to set.

getLinkTargetType()

Indicating the type of target attribute in <a> link. The default value is HtmlLinkTargetType.Parent.

getLinkTargetType() : HtmlLinkTargetType;

Returns

HtmlLinkTargetType

setLinkTargetType(HtmlLinkTargetType)

Indicating the type of target attribute in <a> link. The default value is HtmlLinkTargetType.Parent.

setLinkTargetType(value: HtmlLinkTargetType) : void;

Parameters:

Parameter	Type	Description
value	HtmlLinkTargetType	The value to set.

isIECompatible()

Indicating whether the output HTML is compatible with IE browser. The defalut value is false

isIECompatible() : boolean;

setIsIECompatible(boolean)

Indicating whether the output HTML is compatible with IE browser. The defalut value is false

setIsIECompatible(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

getFormatDataIgnoreColumnWidth() : boolean;

setFormatDataIgnoreColumnWidth(boolean)

setFormatDataIgnoreColumnWidth(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getCalculateFormula()

Indicates whether to calculate formulas before saving html file.

getCalculateFormula() : boolean;

Remarks

The default value is false.

setCalculateFormula(boolean)

Indicates whether to calculate formulas before saving html file.

setCalculateFormula(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

The default value is false.

isJsBrowserCompatible()

Indicates whether JavaScript is compatible with browsers that do not support JavaScript. The default value is true.

isJsBrowserCompatible() : boolean;

setIsJsBrowserCompatible(boolean)

Indicates whether JavaScript is compatible with browsers that do not support JavaScript. The default value is true.

setIsJsBrowserCompatible(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isMobileCompatible()

Indicates whether the output HTML is compatible with mobile devices. The default value is false.

isMobileCompatible() : boolean;

setIsMobileCompatible(boolean)

Indicates whether the output HTML is compatible with mobile devices. The default value is false.

setIsMobileCompatible(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getCssStyles()

Gets or sets the additional css styles for the formatter. Only works when SaveAsSingleFile is True. CssStyles=“body { padding: 5px }”;

getCssStyles() : string;

setCssStyles(string)

Gets or sets the additional css styles for the formatter. Only works when SaveAsSingleFile is True. CssStyles=“body { padding: 5px }”;

setCssStyles(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getHideOverflowWrappedText()

Indicates whether to hide overflow text when the cell format is set to wrap text. The default value is false

getHideOverflowWrappedText() : boolean;

setHideOverflowWrappedText(boolean)

Indicates whether to hide overflow text when the cell format is set to wrap text. The default value is false

setHideOverflowWrappedText(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isBorderCollapsed()

Indicates whether the table borders are collapsed. The default value is true.

isBorderCollapsed() : boolean;

setIsBorderCollapsed(boolean)

Indicates whether the table borders are collapsed. The default value is true.

setIsBorderCollapsed(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getSaveFormat()

Gets the save file format.

getSaveFormat() : SaveFormat;

Returns

SaveFormat

getClearData()

Make the workbook empty after saving the file.

getClearData() : boolean;

setClearData(boolean)

Make the workbook empty after saving the file.

setClearData(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getCachedFileFolder()

The cached file folder is used to store some large data.

getCachedFileFolder() : string;

setCachedFileFolder(string)

The cached file folder is used to store some large data.

setCachedFileFolder(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getValidateMergedAreas()

Indicates whether validate merged cells before saving the file.

getValidateMergedAreas() : boolean;

Remarks

The default value is false.

setValidateMergedAreas(boolean)

Indicates whether validate merged cells before saving the file.

setValidateMergedAreas(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

The default value is false.

getMergeAreas()

Indicates whether merge the areas of conditional formatting and validation before saving the file.

getMergeAreas() : boolean;

Remarks

The default value is false.

setMergeAreas(boolean)

Indicates whether merge the areas of conditional formatting and validation before saving the file.

setMergeAreas(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

The default value is false.

getCreateDirectory()

If true and the directory does not exist, the directory will be automatically created before saving the file.

getCreateDirectory() : boolean;

Remarks

The default value is false.

setCreateDirectory(boolean)

If true and the directory does not exist, the directory will be automatically created before saving the file.

setCreateDirectory(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

The default value is false.

getSortNames()

Indicates whether sorting defined names before saving file.

getSortNames() : boolean;

setSortNames(boolean)

Indicates whether sorting defined names before saving file.

setSortNames(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getSortExternalNames()

Indicates whether sorting external defined names before saving file.

getSortExternalNames() : boolean;

setSortExternalNames(boolean)

Indicates whether sorting external defined names before saving file.

setSortExternalNames(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getRefreshChartCache()

Indicates whether refreshing chart cache data

getRefreshChartCache() : boolean;

setRefreshChartCache(boolean)

Indicates whether refreshing chart cache data

setRefreshChartCache(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

setWarningCallback(IWarningCallback)

Gets or sets warning callback.

setWarningCallback(value: IWarningCallback) : void;

Parameters:

Parameter	Type	Description
value	IWarningCallback	The value to set.

getWarningCallback()

Gets or sets warning callback.

getWarningCallback() : IWarningCallback;

Returns

IWarningCallback

getUpdateSmartArt()

Indicates whether updating smart art setting. The default value is false.

getUpdateSmartArt() : boolean;

Remarks

Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.

setUpdateSmartArt(boolean)

Indicates whether updating smart art setting. The default value is false.

setUpdateSmartArt(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.