com.aspose.cells
Class HtmlSaveOptions

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

public class HtmlSaveOptions 
extends SaveOptions

HtmlSaveOptions

public HtmlSaveOptions()

Creates options for saving html file.

HtmlSaveOptions

public HtmlSaveOptions(int format)

Creates options for saving htm file.

Parameters:

format - A SaveFormat value. The saving file format.

public boolean getIgnoreInvisibleShapes() / public void setIgnoreInvisibleShapes(boolean value)

Indicate whether exporting those not visible shapes

The default values is false.

public void setIgnoreInvisibleShapes(boolean value)

public java.lang.String getPageTitle() / public void setPageTitle(java.lang.String value)

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

public void setPageTitle(java.lang.String value)

public java.lang.String getAttachedFilesDirectory() / public void setAttachedFilesDirectory(java.lang.String value)

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

public void setAttachedFilesDirectory(java.lang.String value)

public java.lang.String getAttachedFilesUrlPrefix() / public void setAttachedFilesUrlPrefix(java.lang.String value)

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

public void setAttachedFilesUrlPrefix(java.lang.String value)

public java.lang.String getDefaultFontName() / public void setDefaultFontName(java.lang.String value)

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

public void setDefaultFontName(java.lang.String value)

public boolean getWorksheetScalable() / 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.

public void setWorksheetScalable(boolean value)

public boolean isExportComments() / public void setExportComments(boolean value)

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

public void setExportComments(boolean value)

public int getExportCommentsType() / public void setExportCommentsType(int value)

Represents type of exporting comments to html files. The value of the property is PrintCommentsType integer constant.

public void setExportCommentsType(int value)

public boolean getDisableDownlevelRevealedComments() / public void setDisableDownlevelRevealedComments(boolean value)

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

public void setDisableDownlevelRevealedComments(boolean value)

public boolean isExpImageToTempDir() / public void setExpImageToTempDir(boolean value)

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

public void setExpImageToTempDir(boolean value)

public boolean getImageScalable() / 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.

public void setImageScalable(boolean value)

public boolean getWidthScalable() / public void setWidthScalable(boolean value)

Indicates whether using scalable unit to describe the column width when exporting file to html. The default value is false.

public void setWidthScalable(boolean value)

public boolean getExportSingleTab() / public void setExportSingleTab(boolean value)

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

public void setExportSingleTab(boolean value)

public boolean getExportImagesAsBase64() / public void setExportImagesAsBase64(boolean value)

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

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

public void setExportImagesAsBase64(boolean value)

public boolean getExportActiveWorksheetOnly() / public void setExportActiveWorksheetOnly(boolean value)

Indicates if exporting the whole workbook to html file.

public void setExportActiveWorksheetOnly(boolean value)

public boolean getExportPrintAreaOnly() / public void setExportPrintAreaOnly(boolean value)

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

public void setExportPrintAreaOnly(boolean value)

public CellArea getExportArea() / public void setExportArea(CellArea value)

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.

public void setExportArea(CellArea value)

public boolean getParseHtmlTagInCell() / public void setParseHtmlTagInCell(boolean value)

Parse html tag in cell,like

,as cell value,or as html tag,default is true

public void setParseHtmlTagInCell(boolean value)

public int getHtmlCrossStringType() / public void setHtmlCrossStringType(int value)

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

public void setHtmlCrossStringType(int value)

public int getHiddenColDisplayType() / public void setHiddenColDisplayType(int value)

Hidden column(the width of this column is 0) in excel,before save this into html format, if HtmlHiddenColDisplayType is "Remove",the hidden column would not been output, if the value is "Hidden", the column would been output,but was hidden,the default value is "Hidden" The value of the property is HtmlHiddenColDisplayType integer constant.

public void setHiddenColDisplayType(int value)

public int getHiddenRowDisplayType() / public void setHiddenRowDisplayType(int value)

Hidden row(the height of this row is 0) in excel,before save this into html format, if HtmlHiddenRowDisplayType is "Remove",the hidden row would not been output, if the value is "Hidden", the row would been output,but was hidden,the default value is "Hidden" The value of the property is HtmlHiddenRowDisplayType integer constant.

public void setHiddenRowDisplayType(int value)

public com.aspose.cells.Encoding getEncoding() / public void setEncoding(com.aspose.cells.Encoding value)

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

public void setEncoding(com.aspose.cells.Encoding value)

public IExportObjectListener getExportObjectListener() / public void setExportObjectListener(IExportObjectListener value)

Gets or sets the ExportObjectListener for exporting objects.

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.

public void setExportObjectListener(IExportObjectListener value)

public IFilePathProvider getFilePathProvider() / public void setFilePathProvider(IFilePathProvider value)

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

public void setFilePathProvider(IFilePathProvider value)

public IStreamProvider getStreamProvider() / public void setStreamProvider(IStreamProvider value)

Gets or sets the IStreamProvider for exporting objects.

public void setStreamProvider(IStreamProvider value)

public ImageOrPrintOptions getImageOptions()

Get the ImageOrPrintOptions object before exporting

public boolean getSaveAsSingleFile() / public void setSaveAsSingleFile(boolean value)

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

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.

public void setSaveAsSingleFile(boolean value)

public boolean getShowAllSheets() / public void setShowAllSheets(boolean value)

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

Only works when SaveAsSingleFile is True.

public void setShowAllSheets(boolean value)

public boolean getExportPageHeaders() / public void setExportPageHeaders(boolean value)

Indicates whether exporting page headers.

Only works when SaveAsSingleFile is True.

public void setExportPageHeaders(boolean value)

public boolean getExportPageFooters() / public void setExportPageFooters(boolean value)

Indicates whether exporting page headers.

Only works when SaveAsSingleFile is True.

public void setExportPageFooters(boolean value)

public boolean getExportHiddenWorksheet() / public void setExportHiddenWorksheet(boolean value)

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

public void setExportHiddenWorksheet(boolean value)

public boolean getPresentationPreference() / 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.

public void setPresentationPreference(boolean value)

public java.lang.String getCellCssPrefix() / public void setCellCssPrefix(java.lang.String value)

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

public void setCellCssPrefix(java.lang.String value)

public java.lang.String getTableCssId() / public void setTableCssId(java.lang.String value)

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 "".

public void setTableCssId(java.lang.String value)

public boolean isFullPathLink() / public void setFullPathLink(boolean value)

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

public void setFullPathLink(boolean value)

public boolean getExportWorksheetCSSSeparately() / public void setExportWorksheetCSSSeparately(boolean value)

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

public void setExportWorksheetCSSSeparately(boolean value)

public boolean getExportSimilarBorderStyle() / public void setExportSimilarBorderStyle(boolean value)

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

public void setExportSimilarBorderStyle(boolean value)

public boolean getMergeEmptyTdForcely() / public void setMergeEmptyTdForcely(boolean value)

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.

public void setMergeEmptyTdForcely(boolean value)

public boolean getExportCellCoordinate() / 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.

public void setExportCellCoordinate(boolean value)

public boolean getExportExtraHeadings() / public void setExportExtraHeadings(boolean value)

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

public void setExportExtraHeadings(boolean value)

public boolean getExportHeadings() / public void setExportHeadings(boolean value)

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

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.

public void setExportHeadings(boolean value)

public boolean getExportRowColumnHeadings() / public void setExportRowColumnHeadings(boolean value)

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

The default value is false.

public void setExportRowColumnHeadings(boolean value)

public boolean getExportFormula() / 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.

public void setExportFormula(boolean value)

public boolean getAddTooltipText() / public void setAddTooltipText(boolean value)

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

public void setAddTooltipText(boolean value)

public boolean getExportGridLines() / public void setExportGridLines(boolean value)

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

public void setExportGridLines(boolean value)

public boolean getExportBogusRowData() / 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.

public void setExportBogusRowData(boolean value)

public boolean getExcludeUnusedStyles() / public void setExcludeUnusedStyles(boolean value)

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

public void setExcludeUnusedStyles(boolean value)

public boolean getExportDocumentProperties() / 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.

public void setExportDocumentProperties(boolean value)

public boolean getExportWorksheetProperties() / 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.

public void setExportWorksheetProperties(boolean value)

public boolean getExportWorkbookProperties() / 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.

public void setExportWorkbookProperties(boolean value)

public boolean getExportFrameScriptsAndProperties() / 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.

public void setExportFrameScriptsAndProperties(boolean value)

public int getExportDataOptions() / public void setExportDataOptions(int value)

Indicating the rule of exporting html file data.The default value is All. The value of the property is HtmlExportDataOptions integer constant.

public void setExportDataOptions(int value)

public int getLinkTargetType() / public void setLinkTargetType(int value)

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

public void setLinkTargetType(int value)

public int getSaveFormat()

Gets the save file format. The value of the property is SaveFormat integer constant.

public boolean getClearData() / public void setClearData(boolean value)

Make the workbook empty after saving the file.

public void setClearData(boolean value)

public java.lang.String getCachedFileFolder() / public void setCachedFileFolder(java.lang.String value)

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

public void setCachedFileFolder(java.lang.String value)

public boolean getValidateMergedAreas() / public void setValidateMergedAreas(boolean value)

Indicates whether validate merged cells before saving the file.

The default value is false.

public void setValidateMergedAreas(boolean value)

public boolean getMergeAreas() / public void setMergeAreas(boolean value)

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

The default value is false.

public void setMergeAreas(boolean value)

public boolean getCreateDirectory() / public void setCreateDirectory(boolean value)

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

The default value is false.

public void setCreateDirectory(boolean value)

public boolean getSortNames() / public void setSortNames(boolean value)

Indicates whether sorting defined names before saving file.

public void setSortNames(boolean value)

public boolean getSortExternalNames() / public void setSortExternalNames(boolean value)

Indicates whether sorting external defined names before saving file.

public void setSortExternalNames(boolean value)

public boolean getRefreshChartCache() / public void setRefreshChartCache(boolean value)

Indicates whether refreshing chart cache data

public void setRefreshChartCache(boolean value)

public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)

Gets or sets warning callback.

public void setWarningCallback(IWarningCallback value)

public boolean getUpdateSmartArt() / public void setUpdateSmartArt(boolean value)

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

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

public void setUpdateSmartArt(boolean value)