EbookSaveOptions

Inheritance: java.lang.Object, com.aspose.cells.SaveOptions, com.aspose.cells.HtmlSaveOptions

public class EbookSaveOptions extends HtmlSaveOptions

Represents the options for saving ebook file.

Constructors

Constructor	Description
EbookSaveOptions()	Creates options for saving ebook file.
EbookSaveOptions(int saveFormat)	Creates options for saving ebook file.

Methods

Method	Description
equals(Object arg0)
getAddGenericFont()	Indicates whether to add a generic font to CSS font-family.
getAddTooltipText()	Indicates whether adding tooltip text when the data can’t be fully displayed.
getAttachedFilesDirectory()	The directory that the attached files will be saved to.
getAttachedFilesUrlPrefix()	Specify the Url prefix of attached files such as image in the html file.
getCachedFileFolder()	The cached file folder is used to store some large data.
getCalculateFormula()	Indicates whether to calculate formulas before saving html file.
getCellCssPrefix()	Gets the prefix of the css name,the default value is “”.
getCellNameAttribute()	Specifies the attribute that indicates the CellName to be written.
getCheckExcelRestriction()	Whether check restriction of excel file when user modify cells related objects.
getClass()
getClearData()	Make the workbook empty after saving the file.
getCreateDirectory()	If true and the directory does not exist, the directory will be automatically created before saving the file.
getCssStyles()	Gets the additional css styles for the formatter.
getDefaultFontName()	Specify the default font name for exporting html, the default font will be used when the font of style is not existing, If this property is null, Aspose.Cells will use universal font which have the same family with the original font, the default value is null.
getDisableCss()	Indicates whether only inline styles are applied, without relying on CSS.
getDisableDownlevelRevealedComments()	Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
getEncodeEntityAsCode()	Indicates whether the html character entities are replaced with decimal code.
getEncoding()	If not set,use Encoding.UTF8 as default enconding type.
getEncryptDocumentProperties()	Indicates whether encrypt document properties when saving as .xls file.
getExcludeUnusedStyles()	Indicating whether excludes unused styles.
getExportActiveWorksheetOnly()	Indicates if only exporting the active worksheet to html file.
getExportArea()	Gets the exporting CellArea of current active Worksheet.
getExportBogusRowData()	Indicating whether exporting bogus bottom row data.
getExportCellCoordinate()	Indicates whether exporting excel coordinate of nonblank cells when saving file to html.
getExportCommentsType()	Represents type of exporting comments to html files.
getExportDataOptions()	Indicating the rule of exporting html file data.The default value is All.
getExportDocumentProperties()	Indicating whether exporting document properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.
getExportExtraHeadings()	Indicates whether exporting extra headings when the length of text is longer than max display column.
getExportFormula()	Indicates whether exporting formula when saving file to html.
getExportFrameScriptsAndProperties()	Indicating whether exporting frame scripts and document properties.
getExportGridLines()	Indicating whether exporting the gridlines.The default value is false.
getExportHeadings()	Indicates whether exports sheet’s row and column headings when saving to HTML files.
getExportHiddenWorksheet()	Indicating if exporting the hidden worksheet content.The default value is true.
getExportImagesAsBase64()	Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
getExportObjectListener()	Gets the ExportObjectListener for exporting objects.
getExportPageFooters()	Indicates whether exporting page headers.
getExportPageHeaders()	Indicates whether exporting page headers.
getExportPrintAreaOnly()	Indicates if only exporting the print area to html file.
getExportRowColumnHeadings()	Indicates whether exports sheet’s row and column headings when saving to HTML files.
getExportSimilarBorderStyle()	Indicating whether exporting the similar border style when the border style is not supported by browsers.
getExportSingleTab()	Indicates whether exporting the single tab when the file only has one worksheet.
getExportWorkbookProperties()	Indicating whether exporting workbook properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.
getExportWorksheetCSSSeparately()	Indicating whether export the worksheet css separately.The default value is false.
getExportWorksheetProperties()	Indicating whether exporting worksheet properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.
getFilePathProvider()	Gets the IFilePathProvider for exporting Worksheet to html separately.
getFormatDataIgnoreColumnWidth()	Indicating whether show the whole formatted data of cell when overflowing the column.
getHiddenColDisplayType()	Hidden column(the width of this column is 0) in excel,before save this into html format, if HtmlHiddenColDisplayType is “Remove”,the hidden column would not been output, if the value is “Hidden”, the column would been output,but was hidden,the default value is “Hidden”
getHiddenRowDisplayType()	Hidden row(the height of this row is 0) in excel,before save this into html format, if HtmlHiddenRowDisplayType is “Remove”,the hidden row would not been output, if the value is “Hidden”, the row would been output,but was hidden,the default value is “Hidden”
getHideOverflowWrappedText()	Indicates whether to hide overflow text when the cell format is set to wrap text.
getHtmlCrossStringType()	Indicates if a cross-cell string will be displayed in the same way as MS Excel when saving an Excel file in html format.
getIgnoreInvisibleShapes()	Indicate whether exporting those not visible shapes
getImageOptions()	Get the ImageOrPrintOptions object before exporting
getImageScalable()	Indicates whether using scalable unit to describe the image width when using scalable unit to describe the column width.
getLinkTargetType()	Indicating the type of target attribute in `<a>` link.
getMergeAreas()	Indicates whether merge the areas of conditional formatting and validation before saving the file.
getMergeEmptyTdForcely()	Indicates whether merging empty TD element forcedly when exporting file to html.
getMergeEmptyTdType()	The option to merge contiguous empty cells(empty td elements) The default value is MergeEmptyTdType.Default.
getOfficeMathOutputMode()	Indicates how export OfficeMath objects to HTML, Default value is Image.
getPageTitle()	The title of the html page.
getParseHtmlTagInCell()	Indicates whether html tag(such as `<div></div>`) in cell should be parsed as cell value or preserved as it is.
getPresentationPreference()	Indicating if html or mht file is presentation preference.
getRefreshChartCache()	Indicates whether refreshing chart cache data
getSaveAsSingleFile()	Indicates whether save the html as single file.
getSaveFormat()	Gets the save file format.
getShowAllSheets()	Indicates whether showing all sheets when saving as a single html file.
getSortExternalNames()	Indicates whether sorting external defined names before saving file.
getSortNames()	Indicates whether sorting defined names before saving file.
getStreamProvider()	Gets the IStreamProvider for exporting objects.
getTableCssId()	Gets the prefix of the type css name such as tr,col,td and so on, they are contained in the table element which has the specific TableCssId attribute.
getUpdateSmartArt()	Indicates whether updating smart art setting.
getValidateMergedAreas()	Indicates whether validate merged cells before saving the file.
getWarningCallback()	Gets warning callback.
getWidthScalable()	Indicates whether exporting column width in unit of scale to html.
getWorksheetScalable()	Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.
hashCode()
isBorderCollapsed()	Indicates whether the table borders are collapsed.
isExpImageToTempDir()	Indicates whether exporting image files to temp directory.
isExportComments()	Indicates if exporting comments when saving file to html, the default value is false.
isFullPathLink()	Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm.
isIECompatible()	Indicating whether the output HTML is compatible with IE browser.
isJsBrowserCompatible()	Indicates whether JavaScript is compatible with browsers that do not support JavaScript.
isMobileCompatible()	Indicates whether the output HTML is compatible with mobile devices.
notify()
notifyAll()
setAddGenericFont(boolean value)	Indicates whether to add a generic font to CSS font-family.
setAddTooltipText(boolean value)	Indicates whether adding tooltip text when the data can’t be fully displayed.
setAttachedFilesDirectory(String value)	The directory that the attached files will be saved to.
setAttachedFilesUrlPrefix(String value)	Specify the Url prefix of attached files such as image in the html file.
setBorderCollapsed(boolean value)	Indicates whether the table borders are collapsed.
setCachedFileFolder(String value)	The cached file folder is used to store some large data.
setCalculateFormula(boolean value)	Indicates whether to calculate formulas before saving html file.
setCellCssPrefix(String value)	Sets the prefix of the css name,the default value is “”.
setCellNameAttribute(String value)	Specifies the attribute that indicates the CellName to be written.
setCheckExcelRestriction(boolean value)	Whether check restriction of excel file when user modify cells related objects.
setClearData(boolean value)	Make the workbook empty after saving the file.
setCreateDirectory(boolean value)	If true and the directory does not exist, the directory will be automatically created before saving the file.
setCssStyles(String value)	Sets the additional css styles for the formatter.
setDefaultFontName(String value)	Specify the default font name for exporting html, the default font will be used when the font of style is not existing, If this property is null, Aspose.Cells will use universal font which have the same family with the original font, the default value is null.
setDisableCss(boolean value)	Indicates whether only inline styles are applied, without relying on CSS.
setDisableDownlevelRevealedComments(boolean value)	Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
setEncodeEntityAsCode(boolean value)	Indicates whether the html character entities are replaced with decimal code.
setEncoding(Encoding value)	If not set,use Encoding.UTF8 as default enconding type.
setEncryptDocumentProperties(boolean value)	Indicates whether encrypt document properties when saving as .xls file.
setExcludeUnusedStyles(boolean value)	Indicating whether excludes unused styles.
setExpImageToTempDir(boolean value)	Indicates whether exporting image files to temp directory.
setExportActiveWorksheetOnly(boolean value)	Indicates if only exporting the active worksheet to html file.
setExportArea(CellArea value)	Sets the exporting CellArea of current active Worksheet.
setExportBogusRowData(boolean value)	Indicating whether exporting bogus bottom row data.
setExportCellCoordinate(boolean value)	Indicates whether exporting excel coordinate of nonblank cells when saving file to html.
setExportComments(boolean value)	Indicates if exporting comments when saving file to html, the default value is false.
setExportCommentsType(int value)	Represents type of exporting comments to html files.
setExportDataOptions(int value)	Indicating the rule of exporting html file data.The default value is All.
setExportDocumentProperties(boolean value)	Indicating whether exporting document properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.
setExportExtraHeadings(boolean value)	Indicates whether exporting extra headings when the length of text is longer than max display column.
setExportFormula(boolean value)	Indicates whether exporting formula when saving file to html.
setExportFrameScriptsAndProperties(boolean value)	Indicating whether exporting frame scripts and document properties.
setExportGridLines(boolean value)	Indicating whether exporting the gridlines.The default value is false.
setExportHeadings(boolean value)	Indicates whether exports sheet’s row and column headings when saving to HTML files.
setExportHiddenWorksheet(boolean value)	Indicating if exporting the hidden worksheet content.The default value is true.
setExportImagesAsBase64(boolean value)	Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
setExportObjectListener(IExportObjectListener value)	Sets the ExportObjectListener for exporting objects.
setExportPageFooters(boolean value)	Indicates whether exporting page headers.
setExportPageHeaders(boolean value)	Indicates whether exporting page headers.
setExportPrintAreaOnly(boolean value)	Indicates if only exporting the print area to html file.
setExportRowColumnHeadings(boolean value)	Indicates whether exports sheet’s row and column headings when saving to HTML files.
setExportSimilarBorderStyle(boolean value)	Indicating whether exporting the similar border style when the border style is not supported by browsers.
setExportSingleTab(boolean value)	Indicates whether exporting the single tab when the file only has one worksheet.
setExportWorkbookProperties(boolean value)	Indicating whether exporting workbook properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.
setExportWorksheetCSSSeparately(boolean value)	Indicating whether export the worksheet css separately.The default value is false.
setExportWorksheetProperties(boolean value)	Indicating whether exporting worksheet properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.
setFilePathProvider(IFilePathProvider value)	Sets the IFilePathProvider for exporting Worksheet to html separately.
setFormatDataIgnoreColumnWidth(boolean value)	Indicating whether show the whole formatted data of cell when overflowing the column.
setFullPathLink(boolean value)	Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm.
setHiddenColDisplayType(int value)	Hidden column(the width of this column is 0) in excel,before save this into html format, if HtmlHiddenColDisplayType is “Remove”,the hidden column would not been output, if the value is “Hidden”, the column would been output,but was hidden,the default value is “Hidden”
setHiddenRowDisplayType(int value)	Hidden row(the height of this row is 0) in excel,before save this into html format, if HtmlHiddenRowDisplayType is “Remove”,the hidden row would not been output, if the value is “Hidden”, the row would been output,but was hidden,the default value is “Hidden”
setHideOverflowWrappedText(boolean value)	Indicates whether to hide overflow text when the cell format is set to wrap text.
setHtmlCrossStringType(int value)	Indicates if a cross-cell string will be displayed in the same way as MS Excel when saving an Excel file in html format.
setIECompatible(boolean value)	Indicating whether the output HTML is compatible with IE browser.
setIgnoreInvisibleShapes(boolean value)	Indicate whether exporting those not visible shapes
setImageScalable(boolean value)	Indicates whether using scalable unit to describe the image width when using scalable unit to describe the column width.
setJsBrowserCompatible(boolean value)	Indicates whether JavaScript is compatible with browsers that do not support JavaScript.
setLinkTargetType(int value)	Indicating the type of target attribute in `<a>` link.
setMergeAreas(boolean value)	Indicates whether merge the areas of conditional formatting and validation before saving the file.
setMergeEmptyTdForcely(boolean value)	Indicates whether merging empty TD element forcedly when exporting file to html.
setMergeEmptyTdType(int value)	The option to merge contiguous empty cells(empty td elements) The default value is MergeEmptyTdType.Default.
setMobileCompatible(boolean value)	Indicates whether the output HTML is compatible with mobile devices.
setOfficeMathOutputMode(int value)	Indicates how export OfficeMath objects to HTML, Default value is Image.
setPageTitle(String value)	The title of the html page.
setParseHtmlTagInCell(boolean value)	Indicates whether html tag(such as `<div></div>`) in cell should be parsed as cell value or preserved as it is.
setPresentationPreference(boolean value)	Indicating if html or mht file is presentation preference.
setRefreshChartCache(boolean value)	Indicates whether refreshing chart cache data
setSaveAsSingleFile(boolean value)	Indicates whether save the html as single file.
setShowAllSheets(boolean value)	Indicates whether showing all sheets when saving as a single html file.
setSortExternalNames(boolean value)	Indicates whether sorting external defined names before saving file.
setSortNames(boolean value)	Indicates whether sorting defined names before saving file.
setStreamProvider(IStreamProvider value)	Sets the IStreamProvider for exporting objects.
setTableCssId(String value)	Sets the prefix of the type css name such as tr,col,td and so on, they are contained in the table element which has the specific TableCssId attribute.
setUpdateSmartArt(boolean value)	Indicates whether updating smart art setting.
setValidateMergedAreas(boolean value)	Indicates whether validate merged cells before saving the file.
setWarningCallback(IWarningCallback value)	Sets warning callback.
setWidthScalable(boolean value)	Indicates whether exporting column width in unit of scale to html.
setWorksheetScalable(boolean value)	Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

EbookSaveOptions()

public EbookSaveOptions()

Creates options for saving ebook file.

EbookSaveOptions(int saveFormat)

public EbookSaveOptions(int saveFormat)

Creates options for saving ebook file.

Parameters:

Parameter	Type	Description
saveFormat	int	SaveFormat. The file format. It should be SaveFormat.EPUB or SaveFormat.AZW_3.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getAddGenericFont()

public boolean getAddGenericFont()

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

Returns: boolean

getAddTooltipText()

public boolean getAddTooltipText()

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

Returns: boolean

getAttachedFilesDirectory()

public String getAttachedFilesDirectory()

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

Returns: java.lang.String

getAttachedFilesUrlPrefix()

public String getAttachedFilesUrlPrefix()

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

Returns: java.lang.String

getCachedFileFolder()

public String getCachedFileFolder()

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

Returns: java.lang.String

getCalculateFormula()

public boolean getCalculateFormula()

Indicates whether to calculate formulas before saving html file.

Remarks

The default value is false.

Returns: boolean

getCellCssPrefix()

public String getCellCssPrefix()

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

Returns: java.lang.String

getCellNameAttribute()

public String getCellNameAttribute()

Specifies the attribute that indicates the CellName to be written. (e.g. If the value is “id”, then for cell “A1”, the output will be:). The default value is null.

Returns: java.lang.String

getCheckExcelRestriction()

public boolean getCheckExcelRestriction()

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.

Returns: boolean

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getClearData()

public boolean getClearData()

Make the workbook empty after saving the file.

Returns: boolean

getCreateDirectory()

public boolean getCreateDirectory()

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

Remarks

The default value is false.

Returns: boolean

getCssStyles()

public String getCssStyles()

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

Returns: java.lang.String

getDefaultFontName()

public String getDefaultFontName()

Specify the default font name for exporting html, the default font will be used when the font of style is not existing, If this property is null, Aspose.Cells will use universal font which have the same family with the original font, the default value is null.

Returns: java.lang.String

getDisableCss()

public boolean getDisableCss()

Indicates whether only inline styles are applied, without relying on CSS. The default value is false.

Returns: boolean

getDisableDownlevelRevealedComments()

public boolean getDisableDownlevelRevealedComments()

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

Returns: boolean

getEncodeEntityAsCode()

public boolean getEncodeEntityAsCode()

Indicates whether the html character entities are replaced with decimal code. (e.g. “ ” is replaced with “ ”). The default value is false.

Returns: boolean

getEncoding()

public Encoding getEncoding()

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

Returns: Encoding

getEncryptDocumentProperties()

public boolean getEncryptDocumentProperties()

Indicates whether encrypt document properties when saving as .xls file. The default value is true.

Remarks

Only for .xls,xlsx,xlsb and xlsm file.

Returns: boolean

getExcludeUnusedStyles()

public boolean getExcludeUnusedStyles()

Indicating whether excludes unused styles. For the generated html files, excluding unused styles can make the file size smaller without affecting the visual effects. So the default value of this property is true. If user needs to keep all styles in the workbook for the generated html(such as the scenario that user needs to restore the workbook from the generated html later), please set this property as false.

Returns: boolean

getExportActiveWorksheetOnly()

public boolean getExportActiveWorksheetOnly()

Indicates if only exporting the active worksheet to html file. If true then only the active worksheet will be exported to html file; If false then the whole workbook will be exported to html file. The default value is false.

Returns: boolean

getExportArea()

public CellArea getExportArea()

Gets the exporting CellArea of current active Worksheet. If you set this attribute, the print area of current active Worksheet will be omitted. Only the specified area will be exported when saving the file to html.

Returns: CellArea

getExportBogusRowData()

public boolean getExportBogusRowData()

Indicating whether exporting bogus bottom row data. The default value is true.If you want to import the html or mht file to excel, please keep the default value.

Returns: boolean

getExportCellCoordinate()

public boolean getExportCellCoordinate()

Indicates whether exporting excel coordinate of nonblank cells when saving file to html. The default value is false. If you want to import the output html to excel, please keep the default value.

Returns: boolean

getExportCommentsType()

public int getExportCommentsType()

Represents type of exporting comments to html files.

See PrintCommentsType.

Returns: int

getExportDataOptions()

public int getExportDataOptions()

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

See HtmlExportDataOptions.

Returns: int

getExportDocumentProperties()

public boolean getExportDocumentProperties()

Indicating whether exporting document properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.

Returns: boolean

getExportExtraHeadings()

public boolean getExportExtraHeadings()

Indicates whether exporting extra headings when the length of text is longer than max display column. The default value is false. If you want to import the html file to excel, please keep the default value.

Returns: boolean

getExportFormula()

public boolean getExportFormula()

Indicates whether exporting formula when saving file to html. The default value is true. If you want to import the output html to excel, please keep the default value.

Returns: boolean

getExportFrameScriptsAndProperties()

public boolean getExportFrameScriptsAndProperties()

Indicating whether exporting frame scripts and document properties. The default value is true.If you want to import the html or mht file to excel, please keep the default value.

Returns: boolean

getExportGridLines()

public boolean getExportGridLines()

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

Returns: boolean

getExportHeadings()

public boolean getExportHeadings()

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

Remarks

NOTE: This member is now obsolete. Instead, please use HtmlSaveOptions.ExportRowColumnHeadings property. This property will be removed 12 months later since June 2022. Aspose apologizes for any inconvenience you may have experienced.

Returns: boolean

getExportHiddenWorksheet()

public boolean getExportHiddenWorksheet()

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

Returns: boolean

getExportImagesAsBase64()

public boolean getExportImagesAsBase64()

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

Remarks

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

Returns: boolean

getExportObjectListener()

public IExportObjectListener getExportObjectListener()

Gets the ExportObjectListener for exporting objects.

Remarks

NOTE: This property is now obsolete. Instead, please use HtmlSaveOptions.IStreamProvider property. This property will be removed 12 months later since August 2015. Aspose apologizes for any inconvenience you may have experienced.

Returns: IExportObjectListener

getExportPageFooters()

public boolean getExportPageFooters()

Indicates whether exporting page headers.

Remarks

Only works when getSaveAsSingleFile() is True.

Returns: boolean

getExportPageHeaders()

public boolean getExportPageHeaders()

Indicates whether exporting page headers.

Remarks

Only works when getSaveAsSingleFile() is True.

Returns: boolean

getExportPrintAreaOnly()

public boolean getExportPrintAreaOnly()

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

Returns: boolean

getExportRowColumnHeadings()

public boolean getExportRowColumnHeadings()

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

Remarks

The default value is false.

Returns: boolean

getExportSimilarBorderStyle()

public boolean getExportSimilarBorderStyle()

Indicating whether exporting the similar border style when the border style is not supported by browsers. If you want to import the html or mht file to excel, please keep the default value. The default value is false.

Returns: boolean

getExportSingleTab()

public boolean getExportSingleTab()

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

Returns: boolean

getExportWorkbookProperties()

public boolean getExportWorkbookProperties()

Indicating whether exporting workbook properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.

Returns: boolean

getExportWorksheetCSSSeparately()

public boolean getExportWorksheetCSSSeparately()

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

Returns: boolean

getExportWorksheetProperties()

public boolean getExportWorksheetProperties()

Indicating whether exporting worksheet properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.

Returns: boolean

getFilePathProvider()

public IFilePathProvider getFilePathProvider()

Gets the IFilePathProvider for exporting Worksheet to html separately.

Returns: IFilePathProvider

getFormatDataIgnoreColumnWidth()

public boolean getFormatDataIgnoreColumnWidth()

Indicating whether show the whole formatted data of cell when overflowing the column. If true then ignore the column width and the whole data of cell will be exported. If false then the data will be exported same as Excel. The default value is false.

Returns: boolean

getHiddenColDisplayType()

public int getHiddenColDisplayType()

Hidden column(the width of this column is 0) in excel,before save this into html format, if HtmlHiddenColDisplayType is “Remove”,the hidden column would not been output, if the value is “Hidden”, the column would been output,but was hidden,the default value is “Hidden”

See HtmlHiddenColDisplayType.

Returns: int

getHiddenRowDisplayType()

public int getHiddenRowDisplayType()

Hidden row(the height of this row is 0) in excel,before save this into html format, if HtmlHiddenRowDisplayType is “Remove”,the hidden row would not been output, if the value is “Hidden”, the row would been output,but was hidden,the default value is “Hidden”

See HtmlHiddenRowDisplayType.

Returns: int

getHideOverflowWrappedText()

public boolean getHideOverflowWrappedText()

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

Returns: boolean

getHtmlCrossStringType()

public int getHtmlCrossStringType()

Indicates if a cross-cell string will be displayed in the same way as MS Excel when saving an Excel file in html format. By default the value is Default, so, for cross-cell strings, there is little difference between the html files created by Aspose.Cells and MS Excel. But the performance for creating large html files,setting the value to Cross would be several times faster than setting it to Default or Fit2Cell.

See HtmlCrossType.

Returns: int

getIgnoreInvisibleShapes()

public boolean getIgnoreInvisibleShapes()

Indicate whether exporting those not visible shapes

Remarks

The default values is false.

Returns: boolean

getImageOptions()

public ImageOrPrintOptions getImageOptions()

Get the ImageOrPrintOptions object before exporting

Returns: ImageOrPrintOptions

getImageScalable()

public boolean getImageScalable()

Indicates whether using scalable unit to describe the image width when using scalable unit to describe the column width. The default value is true.

Returns: boolean

getLinkTargetType()

public int getLinkTargetType()

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

See HtmlLinkTargetType.

Returns: int

getMergeAreas()

public boolean getMergeAreas()

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

Remarks

The default value is false.

Returns: boolean

getMergeEmptyTdForcely()

public boolean getMergeEmptyTdForcely()

Indicates whether merging empty TD element forcedly when exporting file to html. The size of html file will be reduced significantly after setting value to true. The default value is false. If you want to import the html file to excel or export perfect grid lines when saving file to html, please keep the default value.

Returns: boolean

getMergeEmptyTdType()

public int getMergeEmptyTdType()

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

See MergeEmptyTdType.

Returns: int

getOfficeMathOutputMode()

public int getOfficeMathOutputMode()

Indicates how export OfficeMath objects to HTML, Default value is Image.

See HtmlOfficeMathOutputType.

Returns: int

getPageTitle()

public String getPageTitle()

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

Returns: java.lang.String

getParseHtmlTagInCell()

public boolean getParseHtmlTagInCell()

Indicates whether html tag(such as <div></div>) in cell should be parsed as cell value or preserved as it is. The default value is true.

Returns: boolean

getPresentationPreference()

public boolean getPresentationPreference()

Indicating if html or mht file is presentation preference. The default value is false. if you want to get more beautiful presentation,please set the value to true.

Returns: boolean

getRefreshChartCache()

public boolean getRefreshChartCache()

Indicates whether refreshing chart cache data

Returns: boolean

getSaveAsSingleFile()

public boolean getSaveAsSingleFile()

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

Remarks

If there are multiple worksheets or other required resources such as pictures in the workbook, commonly those worksheets and other resources need to be saved into separate files. For some scenarios, user maybe need to get only one resultant file such as for the convenience of transferring. If so, user may set this property as true.

Returns: boolean

getSaveFormat()

public int getSaveFormat()

Gets the save file format.

See SaveFormat.

Returns: int

getShowAllSheets()

public boolean getShowAllSheets()

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

Remarks

Only works when getSaveAsSingleFile() is True.

Returns: boolean

getSortExternalNames()

public boolean getSortExternalNames()

Indicates whether sorting external defined names before saving file.

Returns: boolean

getSortNames()

public boolean getSortNames()

Indicates whether sorting defined names before saving file.

Returns: boolean

getStreamProvider()

public IStreamProvider getStreamProvider()

Gets the IStreamProvider for exporting objects.

Returns: IStreamProvider

getTableCssId()

public String getTableCssId()

Gets the prefix of the type css name such as tr,col,td and so on, they are contained in the table element which has the specific TableCssId attribute. The default value is “”.

Returns: java.lang.String

getUpdateSmartArt()

public boolean getUpdateSmartArt()

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

Remarks

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

Returns: boolean

getValidateMergedAreas()

public boolean getValidateMergedAreas()

Indicates whether validate merged cells before saving the file.

Remarks

The default value is false.

Returns: boolean

getWarningCallback()

public IWarningCallback getWarningCallback()

Gets warning callback.

Returns: IWarningCallback

getWidthScalable()

public boolean getWidthScalable()

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

Returns: boolean

getWorksheetScalable()

public boolean getWorksheetScalable()

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

Returns: boolean

hashCode()

public native int hashCode()

Returns: int

isBorderCollapsed()

public boolean isBorderCollapsed()

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

Returns: boolean

isExpImageToTempDir()

public boolean isExpImageToTempDir()

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

Returns: boolean

isExportComments()

public boolean isExportComments()

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

Returns: boolean

isFullPathLink()

public boolean isFullPathLink()

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

Returns: boolean

isIECompatible()

public boolean isIECompatible()

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

Returns: boolean

isJsBrowserCompatible()

public boolean isJsBrowserCompatible()

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

Returns: boolean

isMobileCompatible()

public boolean isMobileCompatible()

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

Returns: boolean

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setAddGenericFont(boolean value)

public void setAddGenericFont(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setAddTooltipText(boolean value)

public void setAddTooltipText(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setAttachedFilesDirectory(String value)

public void setAttachedFilesDirectory(String value)

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

Parameters:

Parameter	Type	Description
value	java.lang.String

setAttachedFilesUrlPrefix(String value)

public void setAttachedFilesUrlPrefix(String value)

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

Parameters:

Parameter	Type	Description
value	java.lang.String

setBorderCollapsed(boolean value)

public void setBorderCollapsed(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setCachedFileFolder(String value)

public void setCachedFileFolder(String value)

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

Parameters:

Parameter	Type	Description
value	java.lang.String

setCalculateFormula(boolean value)

public void setCalculateFormula(boolean value)

Indicates whether to calculate formulas before saving html file.

Remarks

The default value is false.

Parameters:

Parameter	Type	Description
value	boolean

setCellCssPrefix(String value)

public void setCellCssPrefix(String value)

Sets the prefix of the css name,the default value is “”.

Parameters:

Parameter	Type	Description
value	java.lang.String

setCellNameAttribute(String value)

public void setCellNameAttribute(String value)

Specifies the attribute that indicates the CellName to be written. (e.g. If the value is “id”, then for cell “A1”, the output will be:). The default value is null.

Parameters:

Parameter	Type	Description
value	java.lang.String

setCheckExcelRestriction(boolean value)

public void setCheckExcelRestriction(boolean value)

Parameters:

Parameter	Type	Description
value	boolean

setClearData(boolean value)

public void setClearData(boolean value)

Make the workbook empty after saving the file.

Parameters:

Parameter	Type	Description
value	boolean

setCreateDirectory(boolean value)

public void setCreateDirectory(boolean value)

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

Remarks

The default value is false.

Parameters:

Parameter	Type	Description
value	boolean

setCssStyles(String value)

public void setCssStyles(String value)

Sets the additional css styles for the formatter. Only works when getSaveAsSingleFile() is True. CssStyles=“body { padding: 5px }”;

Parameters:

Parameter	Type	Description
value	java.lang.String

setDefaultFontName(String value)

public void setDefaultFontName(String value)

Parameters:

Parameter	Type	Description
value	java.lang.String

setDisableCss(boolean value)

public void setDisableCss(boolean value)

Indicates whether only inline styles are applied, without relying on CSS. The default value is false.

Parameters:

Parameter	Type	Description
value	boolean

setDisableDownlevelRevealedComments(boolean value)

public void setDisableDownlevelRevealedComments(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setEncodeEntityAsCode(boolean value)

public void setEncodeEntityAsCode(boolean value)

Indicates whether the html character entities are replaced with decimal code. (e.g. “ ” is replaced with “ ”). The default value is false.

Parameters:

Parameter	Type	Description
value	boolean

setEncoding(Encoding value)

public void setEncoding(Encoding value)

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

Parameters:

Parameter	Type	Description
value	Encoding

setEncryptDocumentProperties(boolean value)

public void setEncryptDocumentProperties(boolean value)

Indicates whether encrypt document properties when saving as .xls file. The default value is true.

Remarks

Only for .xls,xlsx,xlsb and xlsm file.

Parameters:

Parameter	Type	Description
value	boolean

setExcludeUnusedStyles(boolean value)

public void setExcludeUnusedStyles(boolean value)

Parameters:

Parameter	Type	Description
value	boolean

setExpImageToTempDir(boolean value)

public void setExpImageToTempDir(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setExportActiveWorksheetOnly(boolean value)

public void setExportActiveWorksheetOnly(boolean value)

Parameters:

Parameter	Type	Description
value	boolean

setExportArea(CellArea value)

public void setExportArea(CellArea value)

Sets the exporting CellArea of current active Worksheet. If you set this attribute, the print area of current active Worksheet will be omitted. Only the specified area will be exported when saving the file to html.

Parameters:

Parameter	Type	Description
value	CellArea

setExportBogusRowData(boolean value)

public void setExportBogusRowData(boolean value)

Indicating whether exporting bogus bottom row data. The default value is true.If you want to import the html or mht file to excel, please keep the default value.

Parameters:

Parameter	Type	Description
value	boolean

setExportCellCoordinate(boolean value)

public void setExportCellCoordinate(boolean value)

Indicates whether exporting excel coordinate of nonblank cells when saving file to html. The default value is false. If you want to import the output html to excel, please keep the default value.

Parameters:

Parameter	Type	Description
value	boolean

setExportComments(boolean value)

public void setExportComments(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setExportCommentsType(int value)

public void setExportCommentsType(int value)

Represents type of exporting comments to html files.

See PrintCommentsType.

Parameters:

Parameter	Type	Description
value	int

setExportDataOptions(int value)

public void setExportDataOptions(int value)

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

See HtmlExportDataOptions.

Parameters:

Parameter	Type	Description
value	int

setExportDocumentProperties(boolean value)

public void setExportDocumentProperties(boolean value)

Indicating whether exporting document properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.

Parameters:

Parameter	Type	Description
value	boolean

setExportExtraHeadings(boolean value)

public void setExportExtraHeadings(boolean value)

Parameters:

Parameter	Type	Description
value	boolean

setExportFormula(boolean value)

public void setExportFormula(boolean value)

Indicates whether exporting formula when saving file to html. The default value is true. If you want to import the output html to excel, please keep the default value.

Parameters:

Parameter	Type	Description
value	boolean

setExportFrameScriptsAndProperties(boolean value)

public void setExportFrameScriptsAndProperties(boolean value)

Indicating whether exporting frame scripts and document properties. The default value is true.If you want to import the html or mht file to excel, please keep the default value.

Parameters:

Parameter	Type	Description
value	boolean

setExportGridLines(boolean value)

public void setExportGridLines(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setExportHeadings(boolean value)

public void setExportHeadings(boolean value)

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

Remarks

Parameters:

Parameter	Type	Description
value	boolean

setExportHiddenWorksheet(boolean value)

public void setExportHiddenWorksheet(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setExportImagesAsBase64(boolean value)

public void setExportImagesAsBase64(boolean value)

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

Remarks

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

Parameters:

Parameter	Type	Description
value	boolean

setExportObjectListener(IExportObjectListener value)

public void setExportObjectListener(IExportObjectListener value)

Sets the ExportObjectListener for exporting objects.

Remarks

Parameters:

Parameter	Type	Description
value	IExportObjectListener

setExportPageFooters(boolean value)

public void setExportPageFooters(boolean value)

Indicates whether exporting page headers.

Remarks

Only works when getSaveAsSingleFile() is True.

Parameters:

Parameter	Type	Description
value	boolean

setExportPageHeaders(boolean value)

public void setExportPageHeaders(boolean value)

Indicates whether exporting page headers.

Remarks

Only works when getSaveAsSingleFile() is True.

Parameters:

Parameter	Type	Description
value	boolean

setExportPrintAreaOnly(boolean value)

public void setExportPrintAreaOnly(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setExportRowColumnHeadings(boolean value)

public void setExportRowColumnHeadings(boolean value)

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

Remarks

The default value is false.

Parameters:

Parameter	Type	Description
value	boolean

setExportSimilarBorderStyle(boolean value)

public void setExportSimilarBorderStyle(boolean value)

Parameters:

Parameter	Type	Description
value	boolean

setExportSingleTab(boolean value)

public void setExportSingleTab(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setExportWorkbookProperties(boolean value)

public void setExportWorkbookProperties(boolean value)

Indicating whether exporting workbook properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.

Parameters:

Parameter	Type	Description
value	boolean

setExportWorksheetCSSSeparately(boolean value)

public void setExportWorksheetCSSSeparately(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setExportWorksheetProperties(boolean value)

public void setExportWorksheetProperties(boolean value)

Indicating whether exporting worksheet properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.

Parameters:

Parameter	Type	Description
value	boolean

setFilePathProvider(IFilePathProvider value)

public void setFilePathProvider(IFilePathProvider value)

Sets the IFilePathProvider for exporting Worksheet to html separately.

Parameters:

Parameter	Type	Description
value	IFilePathProvider

setFormatDataIgnoreColumnWidth(boolean value)

public void setFormatDataIgnoreColumnWidth(boolean value)

Parameters:

Parameter	Type	Description
value	boolean

setFullPathLink(boolean value)

public void setFullPathLink(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setHiddenColDisplayType(int value)

public void setHiddenColDisplayType(int value)

See HtmlHiddenColDisplayType.

Parameters:

Parameter	Type	Description
value	int

setHiddenRowDisplayType(int value)

public void setHiddenRowDisplayType(int value)

See HtmlHiddenRowDisplayType.

Parameters:

Parameter	Type	Description
value	int

setHideOverflowWrappedText(boolean value)

public void setHideOverflowWrappedText(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setHtmlCrossStringType(int value)

public void setHtmlCrossStringType(int value)

See HtmlCrossType.

Parameters:

Parameter	Type	Description
value	int

setIECompatible(boolean value)

public void setIECompatible(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setIgnoreInvisibleShapes(boolean value)

public void setIgnoreInvisibleShapes(boolean value)

Indicate whether exporting those not visible shapes

Remarks

The default values is false.

Parameters:

Parameter	Type	Description
value	boolean

setImageScalable(boolean value)

public void setImageScalable(boolean value)

Indicates whether using scalable unit to describe the image width when using scalable unit to describe the column width. The default value is true.

Parameters:

Parameter	Type	Description
value	boolean

setJsBrowserCompatible(boolean value)

public void setJsBrowserCompatible(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setLinkTargetType(int value)

public void setLinkTargetType(int value)

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

See HtmlLinkTargetType.

Parameters:

Parameter	Type	Description
value	int

setMergeAreas(boolean value)

public void setMergeAreas(boolean value)

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

Remarks

The default value is false.

Parameters:

Parameter	Type	Description
value	boolean

setMergeEmptyTdForcely(boolean value)

public void setMergeEmptyTdForcely(boolean value)

Parameters:

Parameter	Type	Description
value	boolean

setMergeEmptyTdType(int value)

public void setMergeEmptyTdType(int value)

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

See MergeEmptyTdType.

Parameters:

Parameter	Type	Description
value	int

setMobileCompatible(boolean value)

public void setMobileCompatible(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setOfficeMathOutputMode(int value)

public void setOfficeMathOutputMode(int value)

Indicates how export OfficeMath objects to HTML, Default value is Image.

See HtmlOfficeMathOutputType.

Parameters:

Parameter	Type	Description
value	int

setPageTitle(String value)

public void setPageTitle(String value)

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

Parameters:

Parameter	Type	Description
value	java.lang.String

setParseHtmlTagInCell(boolean value)

public void setParseHtmlTagInCell(boolean value)

Indicates whether html tag(such as <div></div>) in cell should be parsed as cell value or preserved as it is. The default value is true.

Parameters:

Parameter	Type	Description
value	boolean

setPresentationPreference(boolean value)

public void setPresentationPreference(boolean value)

Indicating if html or mht file is presentation preference. The default value is false. if you want to get more beautiful presentation,please set the value to true.

Parameters:

Parameter	Type	Description
value	boolean

setRefreshChartCache(boolean value)

public void setRefreshChartCache(boolean value)

Indicates whether refreshing chart cache data

Parameters:

Parameter	Type	Description
value	boolean

setSaveAsSingleFile(boolean value)

public void setSaveAsSingleFile(boolean value)

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

Remarks

Parameters:

Parameter	Type	Description
value	boolean

setShowAllSheets(boolean value)

public void setShowAllSheets(boolean value)

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

Remarks

Only works when getSaveAsSingleFile() is True.

Parameters:

Parameter	Type	Description
value	boolean

setSortExternalNames(boolean value)

public void setSortExternalNames(boolean value)

Indicates whether sorting external defined names before saving file.

Parameters:

Parameter	Type	Description
value	boolean

setSortNames(boolean value)

public void setSortNames(boolean value)

Indicates whether sorting defined names before saving file.

Parameters:

Parameter	Type	Description
value	boolean

setStreamProvider(IStreamProvider value)

public void setStreamProvider(IStreamProvider value)

Sets the IStreamProvider for exporting objects.

Parameters:

Parameter	Type	Description
value	IStreamProvider

setTableCssId(String value)

public void setTableCssId(String value)

Sets the prefix of the type css name such as tr,col,td and so on, they are contained in the table element which has the specific TableCssId attribute. The default value is “”.

Parameters:

Parameter	Type	Description
value	java.lang.String

setUpdateSmartArt(boolean value)

public void setUpdateSmartArt(boolean value)

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

Remarks

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

Parameters:

Parameter	Type	Description
value	boolean

setValidateMergedAreas(boolean value)

public void setValidateMergedAreas(boolean value)

Indicates whether validate merged cells before saving the file.

Remarks

The default value is false.

Parameters:

Parameter	Type	Description
value	boolean

setWarningCallback(IWarningCallback value)

public void setWarningCallback(IWarningCallback value)

Sets warning callback.

Parameters:

Parameter	Type	Description
value	IWarningCallback

setWidthScalable(boolean value)

public void setWidthScalable(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setWorksheetScalable(boolean value)

public void setWorksheetScalable(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int