HtmlSaveOptions
HtmlSaveOptions class
Represents the options for saving html file.
class HtmlSaveOptions extends SaveOptions;
Constructors
Constructor | 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. |
Properties
Property | Type | Description |
---|---|---|
ignoreInvisibleShapes | boolean | Indicate whether exporting those not visible shapes |
pageTitle | string | The title of the html page. Only for saving to html stream. |
attachedFilesDirectory | string | The directory that the attached files will be saved to. Only for saving to html stream. |
attachedFilesUrlPrefix | string | Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream. |
defaultFontName | 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. |
addGenericFont | boolean | Indicates whether to add a generic font to CSS font-family. The default value is true |
worksheetScalable | boolean | Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false. |
isExportComments | boolean | Indicates if exporting comments when saving file to html, the default value is false. |
exportCommentsType | PrintCommentsType | Represents type of exporting comments to html files. |
disableDownlevelRevealedComments | boolean | Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false. |
isExpImageToTempDir | boolean | Indicates whether exporting image files to temp directory. Only for saving to html stream. |
imageScalable | 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. |
widthScalable | boolean | Indicates whether exporting column width in unit of scale to html. The default value is false. |
exportSingleTab | boolean | Indicates whether exporting the single tab when the file only has one worksheet. The default value is false. |
exportImagesAsBase64 | boolean | Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB. |
exportActiveWorksheetOnly | 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. |
exportPrintAreaOnly | boolean | Indicates if only exporting the print area to html file. The default value is false. |
exportArea | 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. |
parseHtmlTagInCell | boolean | Indicates whether html tag(such as |
htmlCrossStringType | 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. |
hiddenColDisplayType | 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” |
hiddenRowDisplayType | 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” |
encoding | EncodingType | If not set,use Encoding.UTF8 as default enconding type. |
filePathProvider | IFilePathProvider | Gets or sets the IFilePathProvider for exporting Worksheet to html separately. |
imageOptions | ImageOrPrintOptions | Readonly. Get the ImageOrPrintOptions object before exporting |
saveAsSingleFile | boolean | Indicates whether save the html as single file. The default value is false. |
showAllSheets | boolean | Indicates whether showing all sheets when saving as a single html file. |
exportPageHeaders | boolean | Indicates whether exporting page headers. |
exportPageFooters | boolean | Indicates whether exporting page headers. |
exportHiddenWorksheet | boolean | Indicating if exporting the hidden worksheet content.The default value is true. |
presentationPreference | 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. |
cellCssPrefix | string | Gets and sets the prefix of the css name,the default value is “”. |
tableCssId | 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 | boolean | Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false. |
exportWorksheetCSSSeparately | boolean | Indicating whether export the worksheet css separately.The default value is false. |
exportSimilarBorderStyle | 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. |
mergeEmptyTdForcely | 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. |
mergeEmptyTdType | MergeEmptyTdType | The option to merge contiguous empty cells(empty td elements) The default value is MergeEmptyTdType.Default. |
exportCellCoordinate | 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. |
exportExtraHeadings | 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. |
exportRowColumnHeadings | boolean | Indicates whether exports sheet’s row and column headings when saving to HTML files. |
exportFormula | 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. |
addTooltipText | boolean | Indicates whether adding tooltip text when the data can’t be fully displayed. The default value is false. |
exportGridLines | boolean | Indicating whether exporting the gridlines.The default value is false. |
exportBogusRowData | 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. |
excludeUnusedStyles | 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. |
exportDocumentProperties | 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. |
exportWorksheetProperties | 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. |
exportWorkbookProperties | 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. |
exportFrameScriptsAndProperties | 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. |
exportDataOptions | HtmlExportDataOptions | Indicating the rule of exporting html file data.The default value is All. |
linkTargetType | HtmlLinkTargetType | Indicating the type of target attribute in |
isIECompatible | boolean | Indicating whether the output HTML is compatible with IE browser. The defalut value is false |
formatDataIgnoreColumnWidth | 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. |
calculateFormula | boolean | Indicates whether to calculate formulas before saving html file. |
isJsBrowserCompatible | boolean | Indicates whether JavaScript is compatible with browsers that do not support JavaScript. The default value is true. |
isMobileCompatible | boolean | Indicates whether the output HTML is compatible with mobile devices. The default value is false. |
cssStyles | string | Gets or sets the additional css styles for the formatter. Only works when SaveAsSingleFile is True. |
hideOverflowWrappedText | boolean | Indicates whether to hide overflow text when the cell format is set to wrap text. The default value is false |
isBorderCollapsed | boolean | Indicates whether the table borders are collapsed. The default value is true. |
encodeEntityAsCode | boolean | Indicates whether the html character entities are replaced with decimal code. (e.g. “ ” is replaced with “ ”). The default value is false. |
officeMathOutputMode | HtmlOfficeMathOutputType | Indicates how export OfficeMath objects to HTML, Default value is Image. |
cellNameAttribute | string | 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. |
disableCss | boolean | Indicates whether only inline styles are applied, without relying on CSS. The default value is false. |
enableCssCustomProperties | boolean | 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. |
htmlVersion | HtmlVersion | Specifies version of HTML standard that should be used when saving the HTML format. Default value is HtmlVersion.Default. |
sheetSet | SheetSet | Gets or sets the sheets to render. Default is all visible sheets in the workbook: Aspose.Cells.Rendering.SheetSet.Visible. |
saveFormat | SaveFormat | Readonly. Gets the save file format. |
clearData | boolean | Make the workbook empty after saving the file. |
cachedFileFolder | string | The folder for temporary files that may be used as data cache. |
validateMergedAreas | boolean | Indicates whether validate merged cells before saving the file. |
mergeAreas | boolean | Indicates whether merge the areas of conditional formatting and validation before saving the file. |
createDirectory | boolean | If true and the directory does not exist, the directory will be automatically created before saving the file. |
sortNames | boolean | Indicates whether sorting defined names before saving file. |
sortExternalNames | boolean | Indicates whether sorting external defined names before saving file. |
refreshChartCache | boolean | Indicates whether refreshing chart cache data |
warningCallback | IWarningCallback | Gets or sets warning callback. |
checkExcelRestriction | boolean | Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated. |
updateSmartArt | boolean | Indicates whether updating smart art setting. The default value is false. |
encryptDocumentProperties | boolean | Indicates whether encrypt document properties when saving as .xls file. The default value is true. |
Methods
Method | Description |
---|---|
getIgnoreInvisibleShapes() | @deprecated. Please use the ‘ignoreInvisibleShapes’ property instead. Indicate whether exporting those not visible shapes |
setIgnoreInvisibleShapes(boolean) | @deprecated. Please use the ‘ignoreInvisibleShapes’ property instead. Indicate whether exporting those not visible shapes |
getPageTitle() | @deprecated. Please use the ‘pageTitle’ property instead. The title of the html page. Only for saving to html stream. |
setPageTitle(string) | @deprecated. Please use the ‘pageTitle’ property instead. The title of the html page. Only for saving to html stream. |
getAttachedFilesDirectory() | @deprecated. Please use the ‘attachedFilesDirectory’ property instead. The directory that the attached files will be saved to. Only for saving to html stream. |
setAttachedFilesDirectory(string) | @deprecated. Please use the ‘attachedFilesDirectory’ property instead. The directory that the attached files will be saved to. Only for saving to html stream. |
getAttachedFilesUrlPrefix() | @deprecated. Please use the ‘attachedFilesUrlPrefix’ property instead. Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream. |
setAttachedFilesUrlPrefix(string) | @deprecated. Please use the ‘attachedFilesUrlPrefix’ property instead. Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream. |
getDefaultFontName() | @deprecated. Please use the ‘defaultFontName’ property instead. 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) | @deprecated. Please use the ‘defaultFontName’ property instead. 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() | @deprecated. Please use the ‘addGenericFont’ property instead. Indicates whether to add a generic font to CSS font-family. The default value is true |
setAddGenericFont(boolean) | @deprecated. Please use the ‘addGenericFont’ property instead. Indicates whether to add a generic font to CSS font-family. The default value is true |
getWorksheetScalable() | @deprecated. Please use the ‘worksheetScalable’ property instead. Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false. |
setWorksheetScalable(boolean) | @deprecated. Please use the ‘worksheetScalable’ property instead. Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false. |
isExportComments() | @deprecated. Please use the ‘isExportComments’ property instead. Indicates if exporting comments when saving file to html, the default value is false. |
setIsExportComments(boolean) | @deprecated. Please use the ‘isExportComments’ property instead. Indicates if exporting comments when saving file to html, the default value is false. |
getExportCommentsType() | @deprecated. Please use the ’exportCommentsType’ property instead. Represents type of exporting comments to html files. |
setExportCommentsType(PrintCommentsType) | @deprecated. Please use the ’exportCommentsType’ property instead. Represents type of exporting comments to html files. |
getDisableDownlevelRevealedComments() | @deprecated. Please use the ‘disableDownlevelRevealedComments’ property instead. Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false. |
setDisableDownlevelRevealedComments(boolean) | @deprecated. Please use the ‘disableDownlevelRevealedComments’ property instead. Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false. |
isExpImageToTempDir() | @deprecated. Please use the ‘isExpImageToTempDir’ property instead. Indicates whether exporting image files to temp directory. Only for saving to html stream. |
setIsExpImageToTempDir(boolean) | @deprecated. Please use the ‘isExpImageToTempDir’ property instead. Indicates whether exporting image files to temp directory. Only for saving to html stream. |
getImageScalable() | @deprecated. Please use the ‘imageScalable’ property instead. 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) | @deprecated. Please use the ‘imageScalable’ property instead. 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() | @deprecated. Please use the ‘widthScalable’ property instead. Indicates whether exporting column width in unit of scale to html. The default value is false. |
setWidthScalable(boolean) | @deprecated. Please use the ‘widthScalable’ property instead. Indicates whether exporting column width in unit of scale to html. The default value is false. |
getExportSingleTab() | @deprecated. Please use the ’exportSingleTab’ property instead. Indicates whether exporting the single tab when the file only has one worksheet. The default value is false. |
setExportSingleTab(boolean) | @deprecated. Please use the ’exportSingleTab’ property instead. Indicates whether exporting the single tab when the file only has one worksheet. The default value is false. |
getExportImagesAsBase64() | @deprecated. Please use the ’exportImagesAsBase64’ property instead. Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB. |
setExportImagesAsBase64(boolean) | @deprecated. Please use the ’exportImagesAsBase64’ property instead. Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB. |
getExportActiveWorksheetOnly() | @deprecated. Please use the ’exportActiveWorksheetOnly’ property instead. 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) | @deprecated. Please use the ’exportActiveWorksheetOnly’ property instead. 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() | @deprecated. Please use the ’exportPrintAreaOnly’ property instead. Indicates if only exporting the print area to html file. The default value is false. |
setExportPrintAreaOnly(boolean) | @deprecated. Please use the ’exportPrintAreaOnly’ property instead. Indicates if only exporting the print area to html file. The default value is false. |
getExportArea() | @deprecated. Please use the ’exportArea’ property instead. 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) | @deprecated. Please use the ’exportArea’ property instead. 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() | @deprecated. Please use the ‘parseHtmlTagInCell’ property instead. Indicates whether html tag(such as |
setParseHtmlTagInCell(boolean) | @deprecated. Please use the ‘parseHtmlTagInCell’ property instead. Indicates whether html tag(such as |
getHtmlCrossStringType() | @deprecated. Please use the ‘htmlCrossStringType’ property instead. 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) | @deprecated. Please use the ‘htmlCrossStringType’ property instead. 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() | @deprecated. Please use the ‘hiddenColDisplayType’ property instead. 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) | @deprecated. Please use the ‘hiddenColDisplayType’ property instead. 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() | @deprecated. Please use the ‘hiddenRowDisplayType’ property instead. 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) | @deprecated. Please use the ‘hiddenRowDisplayType’ property instead. 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() | @deprecated. Please use the ’encoding’ property instead. If not set,use Encoding.UTF8 as default enconding type. |
setEncoding(EncodingType) | @deprecated. Please use the ’encoding’ property instead. If not set,use Encoding.UTF8 as default enconding type. |
getFilePathProvider() | @deprecated. Please use the ‘filePathProvider’ property instead. Gets or sets the IFilePathProvider for exporting Worksheet to html separately. |
setFilePathProvider(IFilePathProvider) | @deprecated. Please use the ‘filePathProvider’ property instead. Gets or sets the IFilePathProvider for exporting Worksheet to html separately. |
getImageOptions() | @deprecated. Please use the ‘imageOptions’ property instead. Get the ImageOrPrintOptions object before exporting |
getSaveAsSingleFile() | @deprecated. Please use the ‘saveAsSingleFile’ property instead. Indicates whether save the html as single file. The default value is false. |
setSaveAsSingleFile(boolean) | @deprecated. Please use the ‘saveAsSingleFile’ property instead. Indicates whether save the html as single file. The default value is false. |
getShowAllSheets() | @deprecated. Please use the ‘showAllSheets’ property instead. Indicates whether showing all sheets when saving as a single html file. |
setShowAllSheets(boolean) | @deprecated. Please use the ‘showAllSheets’ property instead. Indicates whether showing all sheets when saving as a single html file. |
getExportPageHeaders() | @deprecated. Please use the ’exportPageHeaders’ property instead. Indicates whether exporting page headers. |
setExportPageHeaders(boolean) | @deprecated. Please use the ’exportPageHeaders’ property instead. Indicates whether exporting page headers. |
getExportPageFooters() | @deprecated. Please use the ’exportPageFooters’ property instead. Indicates whether exporting page headers. |
setExportPageFooters(boolean) | @deprecated. Please use the ’exportPageFooters’ property instead. Indicates whether exporting page headers. |
getExportHiddenWorksheet() | @deprecated. Please use the ’exportHiddenWorksheet’ property instead. Indicating if exporting the hidden worksheet content.The default value is true. |
setExportHiddenWorksheet(boolean) | @deprecated. Please use the ’exportHiddenWorksheet’ property instead. Indicating if exporting the hidden worksheet content.The default value is true. |
getPresentationPreference() | @deprecated. Please use the ‘presentationPreference’ property instead. 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) | @deprecated. Please use the ‘presentationPreference’ property instead. 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() | @deprecated. Please use the ‘cellCssPrefix’ property instead. Gets and sets the prefix of the css name,the default value is “”. |
setCellCssPrefix(string) | @deprecated. Please use the ‘cellCssPrefix’ property instead. Gets and sets the prefix of the css name,the default value is “”. |
getTableCssId() | @deprecated. Please use the ’tableCssId’ property instead. 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) | @deprecated. Please use the ’tableCssId’ property instead. 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() | @deprecated. Please use the ‘isFullPathLink’ property instead. Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false. |
setIsFullPathLink(boolean) | @deprecated. Please use the ‘isFullPathLink’ property instead. Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false. |
getExportWorksheetCSSSeparately() | @deprecated. Please use the ’exportWorksheetCSSSeparately’ property instead. Indicating whether export the worksheet css separately.The default value is false. |
setExportWorksheetCSSSeparately(boolean) | @deprecated. Please use the ’exportWorksheetCSSSeparately’ property instead. Indicating whether export the worksheet css separately.The default value is false. |
getExportSimilarBorderStyle() | @deprecated. Please use the ’exportSimilarBorderStyle’ property instead. 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) | @deprecated. Please use the ’exportSimilarBorderStyle’ property instead. 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() | @deprecated. Please use the ‘mergeEmptyTdForcely’ property 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(boolean) | @deprecated. Please use the ‘mergeEmptyTdForcely’ property 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() | @deprecated. Please use the ‘mergeEmptyTdType’ property instead. The option to merge contiguous empty cells(empty td elements) The default value is MergeEmptyTdType.Default. |
setMergeEmptyTdType(MergeEmptyTdType) | @deprecated. Please use the ‘mergeEmptyTdType’ property instead. The option to merge contiguous empty cells(empty td elements) The default value is MergeEmptyTdType.Default. |
getExportCellCoordinate() | @deprecated. Please use the ’exportCellCoordinate’ property instead. 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) | @deprecated. Please use the ’exportCellCoordinate’ property instead. 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() | @deprecated. Please use the ’exportExtraHeadings’ property instead. 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) | @deprecated. Please use the ’exportExtraHeadings’ property instead. 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() | @deprecated. Please use the ’exportRowColumnHeadings’ property instead. Indicates whether exports sheet’s row and column headings when saving to HTML files. |
setExportRowColumnHeadings(boolean) | @deprecated. Please use the ’exportRowColumnHeadings’ property instead. Indicates whether exports sheet’s row and column headings when saving to HTML files. |
getExportFormula() | @deprecated. Please use the ’exportFormula’ property instead. 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) | @deprecated. Please use the ’exportFormula’ property instead. 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() | @deprecated. Please use the ‘addTooltipText’ property instead. Indicates whether adding tooltip text when the data can’t be fully displayed. The default value is false. |
setAddTooltipText(boolean) | @deprecated. Please use the ‘addTooltipText’ property instead. Indicates whether adding tooltip text when the data can’t be fully displayed. The default value is false. |
getExportGridLines() | @deprecated. Please use the ’exportGridLines’ property instead. Indicating whether exporting the gridlines.The default value is false. |
setExportGridLines(boolean) | @deprecated. Please use the ’exportGridLines’ property instead. Indicating whether exporting the gridlines.The default value is false. |
getExportBogusRowData() | @deprecated. Please use the ’exportBogusRowData’ property instead. 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) | @deprecated. Please use the ’exportBogusRowData’ property instead. 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() | @deprecated. Please use the ’excludeUnusedStyles’ property instead. 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) | @deprecated. Please use the ’excludeUnusedStyles’ property instead. 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() | @deprecated. Please use the ’exportDocumentProperties’ property instead. 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) | @deprecated. Please use the ’exportDocumentProperties’ property instead. 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() | @deprecated. Please use the ’exportWorksheetProperties’ property instead. 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) | @deprecated. Please use the ’exportWorksheetProperties’ property instead. 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() | @deprecated. Please use the ’exportWorkbookProperties’ property instead. 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) | @deprecated. Please use the ’exportWorkbookProperties’ property instead. 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() | @deprecated. Please use the ’exportFrameScriptsAndProperties’ property instead. 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) | @deprecated. Please use the ’exportFrameScriptsAndProperties’ property instead. 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() | @deprecated. Please use the ’exportDataOptions’ property instead. Indicating the rule of exporting html file data.The default value is All. |
setExportDataOptions(HtmlExportDataOptions) | @deprecated. Please use the ’exportDataOptions’ property instead. Indicating the rule of exporting html file data.The default value is All. |
getLinkTargetType() | @deprecated. Please use the ’linkTargetType’ property instead. Indicating the type of target attribute in |
setLinkTargetType(HtmlLinkTargetType) | @deprecated. Please use the ’linkTargetType’ property instead. Indicating the type of target attribute in |
isIECompatible() | @deprecated. Please use the ‘isIECompatible’ property instead. Indicating whether the output HTML is compatible with IE browser. The defalut value is false |
setIsIECompatible(boolean) | @deprecated. Please use the ‘isIECompatible’ property instead. Indicating whether the output HTML is compatible with IE browser. The defalut value is false |
getFormatDataIgnoreColumnWidth() | @deprecated. Please use the ‘formatDataIgnoreColumnWidth’ property instead. 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) | @deprecated. Please use the ‘formatDataIgnoreColumnWidth’ property instead. 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() | @deprecated. Please use the ‘calculateFormula’ property instead. Indicates whether to calculate formulas before saving html file. |
setCalculateFormula(boolean) | @deprecated. Please use the ‘calculateFormula’ property instead. Indicates whether to calculate formulas before saving html file. |
isJsBrowserCompatible() | @deprecated. Please use the ‘isJsBrowserCompatible’ property instead. Indicates whether JavaScript is compatible with browsers that do not support JavaScript. The default value is true. |
setIsJsBrowserCompatible(boolean) | @deprecated. Please use the ‘isJsBrowserCompatible’ property instead. Indicates whether JavaScript is compatible with browsers that do not support JavaScript. The default value is true. |
isMobileCompatible() | @deprecated. Please use the ‘isMobileCompatible’ property instead. Indicates whether the output HTML is compatible with mobile devices. The default value is false. |
setIsMobileCompatible(boolean) | @deprecated. Please use the ‘isMobileCompatible’ property instead. Indicates whether the output HTML is compatible with mobile devices. The default value is false. |
getCssStyles() | @deprecated. Please use the ‘cssStyles’ property instead. Gets or sets the additional css styles for the formatter. Only works when SaveAsSingleFile is True. |
setCssStyles(string) | @deprecated. Please use the ‘cssStyles’ property instead. Gets or sets the additional css styles for the formatter. Only works when SaveAsSingleFile is True. |
getHideOverflowWrappedText() | @deprecated. Please use the ‘hideOverflowWrappedText’ property instead. Indicates whether to hide overflow text when the cell format is set to wrap text. The default value is false |
setHideOverflowWrappedText(boolean) | @deprecated. Please use the ‘hideOverflowWrappedText’ property instead. Indicates whether to hide overflow text when the cell format is set to wrap text. The default value is false |
isBorderCollapsed() | @deprecated. Please use the ‘isBorderCollapsed’ property instead. Indicates whether the table borders are collapsed. The default value is true. |
setIsBorderCollapsed(boolean) | @deprecated. Please use the ‘isBorderCollapsed’ property instead. Indicates whether the table borders are collapsed. The default value is true. |
getEncodeEntityAsCode() | @deprecated. Please use the ’encodeEntityAsCode’ property instead. Indicates whether the html character entities are replaced with decimal code. (e.g. “ ” is replaced with “ ”). The default value is false. |
setEncodeEntityAsCode(boolean) | @deprecated. Please use the ’encodeEntityAsCode’ property instead. Indicates whether the html character entities are replaced with decimal code. (e.g. “ ” is replaced with “ ”). The default value is false. |
getOfficeMathOutputMode() | @deprecated. Please use the ‘officeMathOutputMode’ property instead. Indicates how export OfficeMath objects to HTML, Default value is Image. |
setOfficeMathOutputMode(HtmlOfficeMathOutputType) | @deprecated. Please use the ‘officeMathOutputMode’ property instead. Indicates how export OfficeMath objects to HTML, Default value is Image. |
getCellNameAttribute() | @deprecated. Please use the ‘cellNameAttribute’ property instead. 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(string) | @deprecated. Please use the ‘cellNameAttribute’ property instead. 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() | @deprecated. Please use the ‘disableCss’ property instead. Indicates whether only inline styles are applied, without relying on CSS. The default value is false. |
setDisableCss(boolean) | @deprecated. Please use the ‘disableCss’ property instead. Indicates whether only inline styles are applied, without relying on CSS. The default value is false. |
getEnableCssCustomProperties() | @deprecated. Please use the ’enableCssCustomProperties’ property instead. 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(boolean) | @deprecated. Please use the ’enableCssCustomProperties’ property instead. 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() | @deprecated. Please use the ‘htmlVersion’ property instead. Specifies version of HTML standard that should be used when saving the HTML format. Default value is HtmlVersion.Default. |
setHtmlVersion(HtmlVersion) | @deprecated. Please use the ‘htmlVersion’ property instead. Specifies version of HTML standard that should be used when saving the HTML format. Default value is HtmlVersion.Default. |
getSheetSet() | @deprecated. Please use the ‘sheetSet’ property instead. Gets or sets the sheets to render. Default is all visible sheets in the workbook: Aspose.Cells.Rendering.SheetSet.Visible. |
setSheetSet(SheetSet) | @deprecated. Please use the ‘sheetSet’ property instead. Gets or sets the sheets to render. Default is all visible sheets in the workbook: Aspose.Cells.Rendering.SheetSet.Visible. |
isNull() | Checks whether the implementation object is null. |
getSaveFormat() | @deprecated. Please use the ‘saveFormat’ property instead. Gets the save file format. |
getClearData() | @deprecated. Please use the ‘clearData’ property instead. Make the workbook empty after saving the file. |
setClearData(boolean) | @deprecated. Please use the ‘clearData’ property instead. Make the workbook empty after saving the file. |
getCachedFileFolder() | @deprecated. Please use the ‘cachedFileFolder’ property instead. The folder for temporary files that may be used as data cache. |
setCachedFileFolder(string) | @deprecated. Please use the ‘cachedFileFolder’ property instead. The folder for temporary files that may be used as data cache. |
getValidateMergedAreas() | @deprecated. Please use the ‘validateMergedAreas’ property instead. Indicates whether validate merged cells before saving the file. |
setValidateMergedAreas(boolean) | @deprecated. Please use the ‘validateMergedAreas’ property instead. Indicates whether validate merged cells before saving the file. |
getMergeAreas() | @deprecated. Please use the ‘mergeAreas’ property instead. Indicates whether merge the areas of conditional formatting and validation before saving the file. |
setMergeAreas(boolean) | @deprecated. Please use the ‘mergeAreas’ property instead. Indicates whether merge the areas of conditional formatting and validation before saving the file. |
getCreateDirectory() | @deprecated. Please use the ‘createDirectory’ property instead. If true and the directory does not exist, the directory will be automatically created before saving the file. |
setCreateDirectory(boolean) | @deprecated. Please use the ‘createDirectory’ property instead. If true and the directory does not exist, the directory will be automatically created before saving the file. |
getSortNames() | @deprecated. Please use the ‘sortNames’ property instead. Indicates whether sorting defined names before saving file. |
setSortNames(boolean) | @deprecated. Please use the ‘sortNames’ property instead. Indicates whether sorting defined names before saving file. |
getSortExternalNames() | @deprecated. Please use the ‘sortExternalNames’ property instead. Indicates whether sorting external defined names before saving file. |
setSortExternalNames(boolean) | @deprecated. Please use the ‘sortExternalNames’ property instead. Indicates whether sorting external defined names before saving file. |
getRefreshChartCache() | @deprecated. Please use the ‘refreshChartCache’ property instead. Indicates whether refreshing chart cache data |
setRefreshChartCache(boolean) | @deprecated. Please use the ‘refreshChartCache’ property instead. Indicates whether refreshing chart cache data |
setWarningCallback(IWarningCallback) | @deprecated. Please use the ‘warningCallback’ property instead. Gets or sets warning callback. |
getWarningCallback() | @deprecated. Please use the ‘warningCallback’ property instead. Gets or sets warning callback. |
getCheckExcelRestriction() | @deprecated. Please use the ‘checkExcelRestriction’ property instead. Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated. |
setCheckExcelRestriction(boolean) | @deprecated. Please use the ‘checkExcelRestriction’ property instead. Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated. |
getUpdateSmartArt() | @deprecated. Please use the ‘updateSmartArt’ property instead. Indicates whether updating smart art setting. The default value is false. |
setUpdateSmartArt(boolean) | @deprecated. Please use the ‘updateSmartArt’ property instead. Indicates whether updating smart art setting. The default value is false. |
getEncryptDocumentProperties() | @deprecated. Please use the ’encryptDocumentProperties’ property instead. Indicates whether encrypt document properties when saving as .xls file. The default value is true. |
setEncryptDocumentProperties(boolean) | @deprecated. Please use the ’encryptDocumentProperties’ property instead. Indicates whether encrypt document properties when saving as .xls file. The default value is true. |
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 or SaveFormat.MHtml, /// otherwise the saved format will be set as SaveFormat.Html automatically. |
ignoreInvisibleShapes
Indicate whether exporting those not visible shapes
ignoreInvisibleShapes : boolean;
Remarks
The default values is false.
pageTitle
The title of the html page. Only for saving to html stream.
pageTitle : string;
attachedFilesDirectory
The directory that the attached files will be saved to. Only for saving to html stream.
attachedFilesDirectory : string;
attachedFilesUrlPrefix
Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.
attachedFilesUrlPrefix : string;
defaultFontName
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.
defaultFontName : string;
addGenericFont
Indicates whether to add a generic font to CSS font-family. The default value is true
addGenericFont : boolean;
worksheetScalable
Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.
worksheetScalable : boolean;
isExportComments
Indicates if exporting comments when saving file to html, the default value is false.
isExportComments : boolean;
exportCommentsType
Represents type of exporting comments to html files.
exportCommentsType : PrintCommentsType;
disableDownlevelRevealedComments
Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
disableDownlevelRevealedComments : boolean;
isExpImageToTempDir
Indicates whether exporting image files to temp directory. Only for saving to html stream.
isExpImageToTempDir : boolean;
imageScalable
Indicates whether using scalable unit to describe the image width when using scalable unit to describe the column width. The default value is true.
imageScalable : boolean;
widthScalable
Indicates whether exporting column width in unit of scale to html. The default value is false.
widthScalable : boolean;
exportSingleTab
Indicates whether exporting the single tab when the file only has one worksheet. The default value is false.
exportSingleTab : boolean;
exportImagesAsBase64
Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
exportImagesAsBase64 : boolean;
Remarks
When this property is set to true image data is exported directly on the img elements and separate files are not created.
exportActiveWorksheetOnly
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.
exportActiveWorksheetOnly : boolean;
exportPrintAreaOnly
Indicates if only exporting the print area to html file. The default value is false.
exportPrintAreaOnly : boolean;
exportArea
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.
exportArea : CellArea;
parseHtmlTagInCell
Indicates whether html tag(such as
parseHtmlTagInCell : boolean;
htmlCrossStringType
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.
htmlCrossStringType : HtmlCrossType;
hiddenColDisplayType
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”
hiddenColDisplayType : HtmlHiddenColDisplayType;
hiddenRowDisplayType
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”
hiddenRowDisplayType : HtmlHiddenRowDisplayType;
encoding
If not set,use Encoding.UTF8 as default enconding type.
encoding : EncodingType;
filePathProvider
Gets or sets the IFilePathProvider for exporting Worksheet to html separately.
filePathProvider : IFilePathProvider;
imageOptions
Readonly. Get the ImageOrPrintOptions object before exporting
imageOptions : ImageOrPrintOptions;
saveAsSingleFile
Indicates whether save the html as single file. The default value is false.
saveAsSingleFile : 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.
showAllSheets
Indicates whether showing all sheets when saving as a single html file.
showAllSheets : boolean;
Remarks
Only works when SaveAsSingleFile is True.
exportPageHeaders
Indicates whether exporting page headers.
exportPageHeaders : boolean;
Remarks
Only works when SaveAsSingleFile is True.
exportPageFooters
Indicates whether exporting page headers.
exportPageFooters : boolean;
Remarks
Only works when SaveAsSingleFile is True.
exportHiddenWorksheet
Indicating if exporting the hidden worksheet content.The default value is true.
exportHiddenWorksheet : boolean;
presentationPreference
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.
presentationPreference : boolean;
cellCssPrefix
Gets and sets the prefix of the css name,the default value is “”.
cellCssPrefix : string;
tableCssId
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 “”.
tableCssId : string;
isFullPathLink
Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false.
isFullPathLink : boolean;
exportWorksheetCSSSeparately
Indicating whether export the worksheet css separately.The default value is false.
exportWorksheetCSSSeparately : boolean;
exportSimilarBorderStyle
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.
exportSimilarBorderStyle : boolean;
mergeEmptyTdForcely
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.
mergeEmptyTdForcely : boolean;
mergeEmptyTdType
The option to merge contiguous empty cells(empty td elements) The default value is MergeEmptyTdType.Default.
mergeEmptyTdType : MergeEmptyTdType;
exportCellCoordinate
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.
exportCellCoordinate : boolean;
exportExtraHeadings
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.
exportExtraHeadings : boolean;
exportRowColumnHeadings
Indicates whether exports sheet’s row and column headings when saving to HTML files.
exportRowColumnHeadings : boolean;
Remarks
The default value is false.
exportFormula
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.
exportFormula : boolean;
addTooltipText
Indicates whether adding tooltip text when the data can’t be fully displayed. The default value is false.
addTooltipText : boolean;
exportGridLines
Indicating whether exporting the gridlines.The default value is false.
exportGridLines : boolean;
exportBogusRowData
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.
exportBogusRowData : boolean;
excludeUnusedStyles
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.
excludeUnusedStyles : boolean;
exportDocumentProperties
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.
exportDocumentProperties : boolean;
exportWorksheetProperties
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.
exportWorksheetProperties : boolean;
exportWorkbookProperties
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.
exportWorkbookProperties : boolean;
exportFrameScriptsAndProperties
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.
exportFrameScriptsAndProperties : boolean;
exportDataOptions
Indicating the rule of exporting html file data.The default value is All.
exportDataOptions : HtmlExportDataOptions;
linkTargetType
Indicating the type of target attribute in
linkTargetType : HtmlLinkTargetType;
isIECompatible
Indicating whether the output HTML is compatible with IE browser. The defalut value is false
isIECompatible : boolean;
formatDataIgnoreColumnWidth
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.
formatDataIgnoreColumnWidth : boolean;
calculateFormula
Indicates whether to calculate formulas before saving html file.
calculateFormula : boolean;
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;
isMobileCompatible
Indicates whether the output HTML is compatible with mobile devices. The default value is false.
isMobileCompatible : boolean;
cssStyles
Gets or sets the additional css styles for the formatter. Only works when SaveAsSingleFile is True.
cssStyles : string;
hideOverflowWrappedText
Indicates whether to hide overflow text when the cell format is set to wrap text. The default value is false
hideOverflowWrappedText : boolean;
isBorderCollapsed
Indicates whether the table borders are collapsed. The default value is true.
isBorderCollapsed : boolean;
encodeEntityAsCode
Indicates whether the html character entities are replaced with decimal code. (e.g. “ ” is replaced with “ ”). The default value is false.
encodeEntityAsCode : boolean;
officeMathOutputMode
Indicates how export OfficeMath objects to HTML, Default value is Image.
officeMathOutputMode : HtmlOfficeMathOutputType;
cellNameAttribute
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.
cellNameAttribute : string;
disableCss
Indicates whether only inline styles are applied, without relying on CSS. The default value is false.
disableCss : boolean;
enableCssCustomProperties
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.
enableCssCustomProperties : boolean;
htmlVersion
Specifies version of HTML standard that should be used when saving the HTML format. Default value is HtmlVersion.Default.
htmlVersion : HtmlVersion;
sheetSet
Gets or sets the sheets to render. Default is all visible sheets in the workbook: Aspose.Cells.Rendering.SheetSet.Visible.
sheetSet : SheetSet;
saveFormat
Readonly. Gets the save file format.
saveFormat : SaveFormat;
clearData
Make the workbook empty after saving the file.
clearData : boolean;
cachedFileFolder
The folder for temporary files that may be used as data cache.
cachedFileFolder : string;
Remarks
If the folder has not been specified, the default value for it is CellsHelper.GetCacheFolder(). If its default value is null or empty, or has been specified as null or empty, then no cache file will be used when saving the workbook.
validateMergedAreas
Indicates whether validate merged cells before saving the file.
validateMergedAreas : boolean;
Remarks
The default value is false.
mergeAreas
Indicates whether merge the areas of conditional formatting and validation before saving the file.
mergeAreas : boolean;
Remarks
The default value is false.
createDirectory
If true and the directory does not exist, the directory will be automatically created before saving the file.
createDirectory : boolean;
Remarks
The default value is false.
sortNames
Indicates whether sorting defined names before saving file.
sortNames : boolean;
sortExternalNames
Indicates whether sorting external defined names before saving file.
sortExternalNames : boolean;
refreshChartCache
Indicates whether refreshing chart cache data
refreshChartCache : boolean;
warningCallback
Gets or sets warning callback.
warningCallback : IWarningCallback;
checkExcelRestriction
Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated.
checkExcelRestriction : boolean;
updateSmartArt
Indicates whether updating smart art setting. The default value is false.
updateSmartArt : boolean;
Remarks
Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
encryptDocumentProperties
Indicates whether encrypt document properties when saving as .xls file. The default value is true.
encryptDocumentProperties : boolean;
Remarks
Only for .xls,xlsx,xlsb and xlsm file.
getIgnoreInvisibleShapes()
@deprecated. Please use the ‘ignoreInvisibleShapes’ property instead. Indicate whether exporting those not visible shapes
getIgnoreInvisibleShapes() : boolean;
Remarks
The default values is false.
setIgnoreInvisibleShapes(boolean)
@deprecated. Please use the ‘ignoreInvisibleShapes’ property instead. 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()
@deprecated. Please use the ‘pageTitle’ property instead. The title of the html page. Only for saving to html stream.
getPageTitle() : string;
setPageTitle(string)
@deprecated. Please use the ‘pageTitle’ property instead. 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()
@deprecated. Please use the ‘attachedFilesDirectory’ property instead. The directory that the attached files will be saved to. Only for saving to html stream.
getAttachedFilesDirectory() : string;
setAttachedFilesDirectory(string)
@deprecated. Please use the ‘attachedFilesDirectory’ property instead. 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()
@deprecated. Please use the ‘attachedFilesUrlPrefix’ property instead. Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.
getAttachedFilesUrlPrefix() : string;
setAttachedFilesUrlPrefix(string)
@deprecated. Please use the ‘attachedFilesUrlPrefix’ property instead. 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()
@deprecated. Please use the ‘defaultFontName’ property instead. 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)
@deprecated. Please use the ‘defaultFontName’ property instead. 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(value: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | string | The value to set. |
getAddGenericFont()
@deprecated. Please use the ‘addGenericFont’ property instead. Indicates whether to add a generic font to CSS font-family. The default value is true
getAddGenericFont() : boolean;
setAddGenericFont(boolean)
@deprecated. Please use the ‘addGenericFont’ property instead. 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()
@deprecated. Please use the ‘worksheetScalable’ property instead. 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)
@deprecated. Please use the ‘worksheetScalable’ property instead. 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()
@deprecated. Please use the ‘isExportComments’ property instead. Indicates if exporting comments when saving file to html, the default value is false.
isExportComments() : boolean;
setIsExportComments(boolean)
@deprecated. Please use the ‘isExportComments’ property instead. 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()
@deprecated. Please use the ’exportCommentsType’ property instead. Represents type of exporting comments to html files.
getExportCommentsType() : PrintCommentsType;
Returns
setExportCommentsType(PrintCommentsType)
@deprecated. Please use the ’exportCommentsType’ property instead. Represents type of exporting comments to html files.
setExportCommentsType(value: PrintCommentsType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | PrintCommentsType | The value to set. |
getDisableDownlevelRevealedComments()
@deprecated. Please use the ‘disableDownlevelRevealedComments’ property instead. Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
getDisableDownlevelRevealedComments() : boolean;
setDisableDownlevelRevealedComments(boolean)
@deprecated. Please use the ‘disableDownlevelRevealedComments’ property instead. 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()
@deprecated. Please use the ‘isExpImageToTempDir’ property instead. Indicates whether exporting image files to temp directory. Only for saving to html stream.
isExpImageToTempDir() : boolean;
setIsExpImageToTempDir(boolean)
@deprecated. Please use the ‘isExpImageToTempDir’ property instead. 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()
@deprecated. Please use the ‘imageScalable’ property instead. 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)
@deprecated. Please use the ‘imageScalable’ property instead. 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()
@deprecated. Please use the ‘widthScalable’ property instead. Indicates whether exporting column width in unit of scale to html. The default value is false.
getWidthScalable() : boolean;
setWidthScalable(boolean)
@deprecated. Please use the ‘widthScalable’ property instead. 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()
@deprecated. Please use the ’exportSingleTab’ property instead. Indicates whether exporting the single tab when the file only has one worksheet. The default value is false.
getExportSingleTab() : boolean;
setExportSingleTab(boolean)
@deprecated. Please use the ’exportSingleTab’ property instead. 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()
@deprecated. Please use the ’exportImagesAsBase64’ property instead. 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)
@deprecated. Please use the ’exportImagesAsBase64’ property instead. 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()
@deprecated. Please use the ’exportActiveWorksheetOnly’ property instead. 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)
@deprecated. Please use the ’exportActiveWorksheetOnly’ property instead. 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(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getExportPrintAreaOnly()
@deprecated. Please use the ’exportPrintAreaOnly’ property instead. Indicates if only exporting the print area to html file. The default value is false.
getExportPrintAreaOnly() : boolean;
setExportPrintAreaOnly(boolean)
@deprecated. Please use the ’exportPrintAreaOnly’ property instead. 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()
@deprecated. Please use the ’exportArea’ property instead. 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
setExportArea(CellArea)
@deprecated. Please use the ’exportArea’ property instead. 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(value: CellArea) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | CellArea | The value to set. |
getParseHtmlTagInCell()
@deprecated. Please use the ‘parseHtmlTagInCell’ property instead. Indicates whether html tag(such as
getParseHtmlTagInCell() : boolean;
setParseHtmlTagInCell(boolean)
@deprecated. Please use the ‘parseHtmlTagInCell’ property instead. Indicates whether html tag(such as
setParseHtmlTagInCell(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getHtmlCrossStringType()
@deprecated. Please use the ‘htmlCrossStringType’ property instead. 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
setHtmlCrossStringType(HtmlCrossType)
@deprecated. Please use the ‘htmlCrossStringType’ property instead. 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(value: HtmlCrossType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | HtmlCrossType | The value to set. |
getHiddenColDisplayType()
@deprecated. Please use the ‘hiddenColDisplayType’ property instead. 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
setHiddenColDisplayType(HtmlHiddenColDisplayType)
@deprecated. Please use the ‘hiddenColDisplayType’ property instead. 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(value: HtmlHiddenColDisplayType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | HtmlHiddenColDisplayType | The value to set. |
getHiddenRowDisplayType()
@deprecated. Please use the ‘hiddenRowDisplayType’ property instead. 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
setHiddenRowDisplayType(HtmlHiddenRowDisplayType)
@deprecated. Please use the ‘hiddenRowDisplayType’ property instead. 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(value: HtmlHiddenRowDisplayType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | HtmlHiddenRowDisplayType | The value to set. |
getEncoding()
@deprecated. Please use the ’encoding’ property instead. If not set,use Encoding.UTF8 as default enconding type.
getEncoding() : EncodingType;
Returns
setEncoding(EncodingType)
@deprecated. Please use the ’encoding’ property instead. 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()
@deprecated. Please use the ‘filePathProvider’ property instead. Gets or sets the IFilePathProvider for exporting Worksheet to html separately.
getFilePathProvider() : IFilePathProvider;
Returns
setFilePathProvider(IFilePathProvider)
@deprecated. Please use the ‘filePathProvider’ property instead. 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()
@deprecated. Please use the ‘imageOptions’ property instead. Get the ImageOrPrintOptions object before exporting
getImageOptions() : ImageOrPrintOptions;
Returns
getSaveAsSingleFile()
@deprecated. Please use the ‘saveAsSingleFile’ property instead. 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)
@deprecated. Please use the ‘saveAsSingleFile’ property instead. 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
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()
@deprecated. Please use the ‘showAllSheets’ property instead. Indicates whether showing all sheets when saving as a single html file.
getShowAllSheets() : boolean;
Remarks
Only works when SaveAsSingleFile is True.
setShowAllSheets(boolean)
@deprecated. Please use the ‘showAllSheets’ property instead. 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()
@deprecated. Please use the ’exportPageHeaders’ property instead. Indicates whether exporting page headers.
getExportPageHeaders() : boolean;
Remarks
Only works when SaveAsSingleFile is True.
setExportPageHeaders(boolean)
@deprecated. Please use the ’exportPageHeaders’ property instead. 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()
@deprecated. Please use the ’exportPageFooters’ property instead. Indicates whether exporting page headers.
getExportPageFooters() : boolean;
Remarks
Only works when SaveAsSingleFile is True.
setExportPageFooters(boolean)
@deprecated. Please use the ’exportPageFooters’ property instead. 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()
@deprecated. Please use the ’exportHiddenWorksheet’ property instead. Indicating if exporting the hidden worksheet content.The default value is true.
getExportHiddenWorksheet() : boolean;
setExportHiddenWorksheet(boolean)
@deprecated. Please use the ’exportHiddenWorksheet’ property instead. 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()
@deprecated. Please use the ‘presentationPreference’ property instead. 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)
@deprecated. Please use the ‘presentationPreference’ property instead. 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()
@deprecated. Please use the ‘cellCssPrefix’ property instead. Gets and sets the prefix of the css name,the default value is “”.
getCellCssPrefix() : string;
setCellCssPrefix(string)
@deprecated. Please use the ‘cellCssPrefix’ property instead. 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()
@deprecated. Please use the ’tableCssId’ property instead. 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)
@deprecated. Please use the ’tableCssId’ property instead. 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()
@deprecated. Please use the ‘isFullPathLink’ property instead. Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false.
isFullPathLink() : boolean;
setIsFullPathLink(boolean)
@deprecated. Please use the ‘isFullPathLink’ property instead. 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()
@deprecated. Please use the ’exportWorksheetCSSSeparately’ property instead. Indicating whether export the worksheet css separately.The default value is false.
getExportWorksheetCSSSeparately() : boolean;
setExportWorksheetCSSSeparately(boolean)
@deprecated. Please use the ’exportWorksheetCSSSeparately’ property instead. 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()
@deprecated. Please use the ’exportSimilarBorderStyle’ property instead. 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)
@deprecated. Please use the ’exportSimilarBorderStyle’ property instead. 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(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getMergeEmptyTdForcely()
@deprecated. Please use the ‘mergeEmptyTdForcely’ property 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.
getMergeEmptyTdForcely() : boolean;
setMergeEmptyTdForcely(boolean)
@deprecated. Please use the ‘mergeEmptyTdForcely’ property 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(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getMergeEmptyTdType()
@deprecated. Please use the ‘mergeEmptyTdType’ property instead. The option to merge contiguous empty cells(empty td elements) The default value is MergeEmptyTdType.Default.
getMergeEmptyTdType() : MergeEmptyTdType;
Returns
setMergeEmptyTdType(MergeEmptyTdType)
@deprecated. Please use the ‘mergeEmptyTdType’ property instead. 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()
@deprecated. Please use the ’exportCellCoordinate’ property instead. 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)
@deprecated. Please use the ’exportCellCoordinate’ property instead. 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()
@deprecated. Please use the ’exportExtraHeadings’ property instead. 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)
@deprecated. Please use the ’exportExtraHeadings’ property instead. 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(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getExportRowColumnHeadings()
@deprecated. Please use the ’exportRowColumnHeadings’ property instead. Indicates whether exports sheet’s row and column headings when saving to HTML files.
getExportRowColumnHeadings() : boolean;
Remarks
The default value is false.
setExportRowColumnHeadings(boolean)
@deprecated. Please use the ’exportRowColumnHeadings’ property instead. 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()
@deprecated. Please use the ’exportFormula’ property instead. 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)
@deprecated. Please use the ’exportFormula’ property instead. 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()
@deprecated. Please use the ‘addTooltipText’ property instead. Indicates whether adding tooltip text when the data can’t be fully displayed. The default value is false.
getAddTooltipText() : boolean;
setAddTooltipText(boolean)
@deprecated. Please use the ‘addTooltipText’ property instead. 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()
@deprecated. Please use the ’exportGridLines’ property instead. Indicating whether exporting the gridlines.The default value is false.
getExportGridLines() : boolean;
setExportGridLines(boolean)
@deprecated. Please use the ’exportGridLines’ property instead. 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()
@deprecated. Please use the ’exportBogusRowData’ property instead. 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)
@deprecated. Please use the ’exportBogusRowData’ property instead. 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()
@deprecated. Please use the ’excludeUnusedStyles’ property instead. 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)
@deprecated. Please use the ’excludeUnusedStyles’ property instead. 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(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getExportDocumentProperties()
@deprecated. Please use the ’exportDocumentProperties’ property instead. 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)
@deprecated. Please use the ’exportDocumentProperties’ property instead. 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()
@deprecated. Please use the ’exportWorksheetProperties’ property instead. 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)
@deprecated. Please use the ’exportWorksheetProperties’ property instead. 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()
@deprecated. Please use the ’exportWorkbookProperties’ property instead. 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)
@deprecated. Please use the ’exportWorkbookProperties’ property instead. 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()
@deprecated. Please use the ’exportFrameScriptsAndProperties’ property instead. 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)
@deprecated. Please use the ’exportFrameScriptsAndProperties’ property instead. 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()
@deprecated. Please use the ’exportDataOptions’ property instead. Indicating the rule of exporting html file data.The default value is All.
getExportDataOptions() : HtmlExportDataOptions;
Returns
setExportDataOptions(HtmlExportDataOptions)
@deprecated. Please use the ’exportDataOptions’ property instead. 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()
@deprecated. Please use the ’linkTargetType’ property instead. Indicating the type of target attribute in
getLinkTargetType() : HtmlLinkTargetType;
Returns
setLinkTargetType(HtmlLinkTargetType)
@deprecated. Please use the ’linkTargetType’ property instead. Indicating the type of target attribute in
setLinkTargetType(value: HtmlLinkTargetType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | HtmlLinkTargetType | The value to set. |
isIECompatible()
@deprecated. Please use the ‘isIECompatible’ property instead. Indicating whether the output HTML is compatible with IE browser. The defalut value is false
isIECompatible() : boolean;
setIsIECompatible(boolean)
@deprecated. Please use the ‘isIECompatible’ property instead. 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()
@deprecated. Please use the ‘formatDataIgnoreColumnWidth’ property instead. 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)
@deprecated. Please use the ‘formatDataIgnoreColumnWidth’ property instead. 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(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getCalculateFormula()
@deprecated. Please use the ‘calculateFormula’ property instead. Indicates whether to calculate formulas before saving html file.
getCalculateFormula() : boolean;
Remarks
The default value is false.
setCalculateFormula(boolean)
@deprecated. Please use the ‘calculateFormula’ property instead. 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()
@deprecated. Please use the ‘isJsBrowserCompatible’ property instead. Indicates whether JavaScript is compatible with browsers that do not support JavaScript. The default value is true.
isJsBrowserCompatible() : boolean;
setIsJsBrowserCompatible(boolean)
@deprecated. Please use the ‘isJsBrowserCompatible’ property instead. 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()
@deprecated. Please use the ‘isMobileCompatible’ property instead. Indicates whether the output HTML is compatible with mobile devices. The default value is false.
isMobileCompatible() : boolean;
setIsMobileCompatible(boolean)
@deprecated. Please use the ‘isMobileCompatible’ property instead. 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()
@deprecated. Please use the ‘cssStyles’ property instead. Gets or sets the additional css styles for the formatter. Only works when SaveAsSingleFile is True.
getCssStyles() : string;
setCssStyles(string)
@deprecated. Please use the ‘cssStyles’ property instead. Gets or sets the additional css styles for the formatter. Only works when SaveAsSingleFile is True.
setCssStyles(value: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | string | The value to set. |
getHideOverflowWrappedText()
@deprecated. Please use the ‘hideOverflowWrappedText’ property instead. Indicates whether to hide overflow text when the cell format is set to wrap text. The default value is false
getHideOverflowWrappedText() : boolean;
setHideOverflowWrappedText(boolean)
@deprecated. Please use the ‘hideOverflowWrappedText’ property instead. 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()
@deprecated. Please use the ‘isBorderCollapsed’ property instead. Indicates whether the table borders are collapsed. The default value is true.
isBorderCollapsed() : boolean;
setIsBorderCollapsed(boolean)
@deprecated. Please use the ‘isBorderCollapsed’ property instead. 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. |
getEncodeEntityAsCode()
@deprecated. Please use the ’encodeEntityAsCode’ property instead. Indicates whether the html character entities are replaced with decimal code. (e.g. “ ” is replaced with “ ”). The default value is false.
getEncodeEntityAsCode() : boolean;
setEncodeEntityAsCode(boolean)
@deprecated. Please use the ’encodeEntityAsCode’ property instead. Indicates whether the html character entities are replaced with decimal code. (e.g. “ ” is replaced with “ ”). The default value is false.
setEncodeEntityAsCode(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getOfficeMathOutputMode()
@deprecated. Please use the ‘officeMathOutputMode’ property instead. Indicates how export OfficeMath objects to HTML, Default value is Image.
getOfficeMathOutputMode() : HtmlOfficeMathOutputType;
Returns
setOfficeMathOutputMode(HtmlOfficeMathOutputType)
@deprecated. Please use the ‘officeMathOutputMode’ property instead. Indicates how export OfficeMath objects to HTML, Default value is Image.
setOfficeMathOutputMode(value: HtmlOfficeMathOutputType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | HtmlOfficeMathOutputType | The value to set. |
getCellNameAttribute()
@deprecated. Please use the ‘cellNameAttribute’ property instead. 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.
getCellNameAttribute() : string;
setCellNameAttribute(string)
@deprecated. Please use the ‘cellNameAttribute’ property instead. 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(value: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | string | The value to set. |
getDisableCss()
@deprecated. Please use the ‘disableCss’ property instead. Indicates whether only inline styles are applied, without relying on CSS. The default value is false.
getDisableCss() : boolean;
setDisableCss(boolean)
@deprecated. Please use the ‘disableCss’ property instead. Indicates whether only inline styles are applied, without relying on CSS. The default value is false.
setDisableCss(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getEnableCssCustomProperties()
@deprecated. Please use the ’enableCssCustomProperties’ property instead. 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.
getEnableCssCustomProperties() : boolean;
setEnableCssCustomProperties(boolean)
@deprecated. Please use the ’enableCssCustomProperties’ property instead. 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(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getHtmlVersion()
@deprecated. Please use the ‘htmlVersion’ property instead. Specifies version of HTML standard that should be used when saving the HTML format. Default value is HtmlVersion.Default.
getHtmlVersion() : HtmlVersion;
Returns
setHtmlVersion(HtmlVersion)
@deprecated. Please use the ‘htmlVersion’ property instead. Specifies version of HTML standard that should be used when saving the HTML format. Default value is HtmlVersion.Default.
setHtmlVersion(value: HtmlVersion) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | HtmlVersion | The value to set. |
getSheetSet()
@deprecated. Please use the ‘sheetSet’ property instead. Gets or sets the sheets to render. Default is all visible sheets in the workbook: Aspose.Cells.Rendering.SheetSet.Visible.
getSheetSet() : SheetSet;
Returns
setSheetSet(SheetSet)
@deprecated. Please use the ‘sheetSet’ property instead. Gets or sets the sheets to render. Default is all visible sheets in the workbook: Aspose.Cells.Rendering.SheetSet.Visible.
setSheetSet(value: SheetSet) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | SheetSet | The value to set. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;
getSaveFormat()
@deprecated. Please use the ‘saveFormat’ property instead. Gets the save file format.
getSaveFormat() : SaveFormat;
Returns
getClearData()
@deprecated. Please use the ‘clearData’ property instead. Make the workbook empty after saving the file.
getClearData() : boolean;
setClearData(boolean)
@deprecated. Please use the ‘clearData’ property instead. Make the workbook empty after saving the file.
setClearData(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getCachedFileFolder()
@deprecated. Please use the ‘cachedFileFolder’ property instead. The folder for temporary files that may be used as data cache.
getCachedFileFolder() : string;
Remarks
If the folder has not been specified, the default value for it is CellsHelper.GetCacheFolder(). If its default value is null or empty, or has been specified as null or empty, then no cache file will be used when saving the workbook.
setCachedFileFolder(string)
@deprecated. Please use the ‘cachedFileFolder’ property instead. The folder for temporary files that may be used as data cache.
setCachedFileFolder(value: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | string | The value to set. |
Remarks
If the folder has not been specified, the default value for it is CellsHelper.GetCacheFolder(). If its default value is null or empty, or has been specified as null or empty, then no cache file will be used when saving the workbook.
getValidateMergedAreas()
@deprecated. Please use the ‘validateMergedAreas’ property instead. Indicates whether validate merged cells before saving the file.
getValidateMergedAreas() : boolean;
Remarks
The default value is false.
setValidateMergedAreas(boolean)
@deprecated. Please use the ‘validateMergedAreas’ property instead. 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()
@deprecated. Please use the ‘mergeAreas’ property instead. Indicates whether merge the areas of conditional formatting and validation before saving the file.
getMergeAreas() : boolean;
Remarks
The default value is false.
setMergeAreas(boolean)
@deprecated. Please use the ‘mergeAreas’ property instead. 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()
@deprecated. Please use the ‘createDirectory’ property instead. 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)
@deprecated. Please use the ‘createDirectory’ property instead. 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()
@deprecated. Please use the ‘sortNames’ property instead. Indicates whether sorting defined names before saving file.
getSortNames() : boolean;
setSortNames(boolean)
@deprecated. Please use the ‘sortNames’ property instead. Indicates whether sorting defined names before saving file.
setSortNames(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getSortExternalNames()
@deprecated. Please use the ‘sortExternalNames’ property instead. Indicates whether sorting external defined names before saving file.
getSortExternalNames() : boolean;
setSortExternalNames(boolean)
@deprecated. Please use the ‘sortExternalNames’ property instead. Indicates whether sorting external defined names before saving file.
setSortExternalNames(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getRefreshChartCache()
@deprecated. Please use the ‘refreshChartCache’ property instead. Indicates whether refreshing chart cache data
getRefreshChartCache() : boolean;
setRefreshChartCache(boolean)
@deprecated. Please use the ‘refreshChartCache’ property instead. Indicates whether refreshing chart cache data
setRefreshChartCache(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
setWarningCallback(IWarningCallback)
@deprecated. Please use the ‘warningCallback’ property instead. Gets or sets warning callback.
setWarningCallback(value: IWarningCallback) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | IWarningCallback | The value to set. |
getWarningCallback()
@deprecated. Please use the ‘warningCallback’ property instead. Gets or sets warning callback.
getWarningCallback() : IWarningCallback;
Returns
getCheckExcelRestriction()
@deprecated. Please use the ‘checkExcelRestriction’ property instead. Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated.
getCheckExcelRestriction() : boolean;
setCheckExcelRestriction(boolean)
@deprecated. Please use the ‘checkExcelRestriction’ property instead. Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated.
setCheckExcelRestriction(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getUpdateSmartArt()
@deprecated. Please use the ‘updateSmartArt’ property instead. 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)
@deprecated. Please use the ‘updateSmartArt’ property instead. 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.
getEncryptDocumentProperties()
@deprecated. Please use the ’encryptDocumentProperties’ property instead. Indicates whether encrypt document properties when saving as .xls file. The default value is true.
getEncryptDocumentProperties() : boolean;
Remarks
Only for .xls,xlsx,xlsb and xlsm file.
setEncryptDocumentProperties(boolean)
@deprecated. Please use the ’encryptDocumentProperties’ property instead. Indicates whether encrypt document properties when saving as .xls file. The default value is true.
setEncryptDocumentProperties(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
Remarks
Only for .xls,xlsx,xlsb and xlsm file.