Constructor Summary |
---|
HtmlSaveOptions()
Creates options for saving html file. |
HtmlSaveOptions(format)
Creates options for saving htm file. |
Property Getters/Setters Summary | ||
---|---|---|
method | getAddTooltipText() | |
method | setAddTooltipText(value) | |
Indicates whether adding tooltip text when the data can't be fully displayed. The default value is false. | ||
method | getAttachedFilesDirectory() | |
method | setAttachedFilesDirectory(value) | |
The directory that the attached files will be saved to. Only for saving to html stream. | ||
method | getAttachedFilesUrlPrefix() | |
method | setAttachedFilesUrlPrefix(value) | |
Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream. | ||
method | getCachedFileFolder() | |
method | setCachedFileFolder(value) | |
The cached file folder is used to store some large data. | ||
method | getCellCssPrefix() | |
method | setCellCssPrefix(value) | |
Gets and sets the prefix of the css name,the default value is "". | ||
method | getClearData() | |
method | setClearData(value) | |
Make the workbook empty after saving the file. | ||
method | getCreateDirectory() | |
method | setCreateDirectory(value) | |
If true and the directory does not exist, the directory will be automatically created before saving the file. | ||
method | getDefaultFontName() | |
method | setDefaultFontName(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. | ||
method | getDisableDownlevelRevealedComments() | |
method | ||
Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false. | ||
method | getEnableHTTPCompression() | |
method | setEnableHTTPCompression(value) | |
Indicates if http compression is to be used in user's IIS. | ||
method | getEncoding() | |
method | setEncoding(value) | |
If not set,use Encoding.UTF8 as default enconding type. | ||
method | getExcludeUnusedStyles() | |
method | setExcludeUnusedStyles(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. | ||
method | getExportActiveWorksheetOnly() | |
method | setExportActiveWorksheetOnly(value) | |
Indicates if exporting the whole workbook to html file. | ||
method | getExportArea() | |
method | setExportArea(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. | ||
method | getExportBogusRowData() | |
method | setExportBogusRowData(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. | ||
method | getExportCellCoordinate() | |
method | setExportCellCoordinate(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. | ||
method | getExportDataOptions() | |
method | setExportDataOptions(value) | |
Indicating the rule of exporting html file data.The default value is All. The value of the property is HtmlExportDataOptions integer constant. | ||
method | getExportDocumentProperties() | |
method | setExportDocumentProperties(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. | ||
method | getExportExtraHeadings() | |
method | setExportExtraHeadings(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. | ||
method | getExportFormula() | |
method | setExportFormula(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. | ||
method | getExportFrameScriptsAndProperties() | |
method | ||
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. | ||
method | getExportGridLines() | |
method | setExportGridLines(value) | |
Indicating whether exporting the gridlines.The default value is false. | ||
method | getExportHeadings() | |
method | setExportHeadings(value) | |
Indicates whether exporting headings when saving file to html.The default value is false. If you want to import the html file to excel, please keep the default value. | ||
method | getExportHiddenWorksheet() | |
method | setExportHiddenWorksheet(value) | |
Indicating if exporting the hidden worksheet content.The default value is true. | ||
method | getExportImagesAsBase64() | |
method | setExportImagesAsBase64(value) | |
Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB. | ||
method | getExportObjectListener() | |
method | setExportObjectListener(value) | |
Gets or sets the ExportObjectListener for exporting objects. | ||
method | getExportPrintAreaOnly() | |
method | setExportPrintAreaOnly(value) | |
Indicates if only exporting the print area to html file. The default value is false. | ||
method | getExportSimilarBorderStyle() | |
method | setExportSimilarBorderStyle(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. | ||
method | getExportSingleTab() | |
method | setExportSingleTab(value) | |
Indicates whether exporting the single tab when the file only has one worksheet. The default value is false. | ||
method | getExportWorkbookProperties() | |
method | setExportWorkbookProperties(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. | ||
method | getExportWorksheetCSSSeparately() | |
method | ||
Indicating whether export the worksheet css separately.The default value is false. | ||
method | getExportWorksheetProperties() | |
method | setExportWorksheetProperties(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. | ||
method | getFilePathProvider() | |
method | setFilePathProvider(value) | |
Gets or sets the IFilePathProvider for exporting Worksheet to html separately. | ||
method | getHiddenColDisplayType() | |
method | setHiddenColDisplayType(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. | ||
method | getHiddenRowDisplayType() | |
method | setHiddenRowDisplayType(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. | ||
method | getHtmlCrossStringType() | |
method | setHtmlCrossStringType(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. | ||
method | getIgnoreInvisibleShapes() | |
method | setIgnoreInvisibleShapes(value) | |
Indicate whether exporting those not visible shapes | ||
method | getImageOptions() | |
Get the ImageOrPrintOptions object before exporting
|
||
method | getImageScalable() | |
method | setImageScalable(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. | ||
method | isExpImageToTempDir() | |
method | setExpImageToTempDir(value) | |
Indicates whether exporting image files to temp directory. Only for saving to html stream. | ||
method | isExportComments() | |
method | setExportComments(value) | |
Indicates if exporting comments when saving file to html, the default value is false. | ||
method | isFullPathLink() | |
method | setFullPathLink(value) | |
Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false. | ||
method | getLinkTargetType() | |
method | setLinkTargetType(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. | ||
method | getMergeAreas() | |
method | setMergeAreas(value) | |
Indicates whether merge the areas of conditional formatting and validation before saving the file. | ||
method | getMergeEmptyTdForcely() | |
method | setMergeEmptyTdForcely(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. | ||
method | getPageTitle() | |
method | setPageTitle(value) | |
The title of the html page. Only for saving to html stream. | ||
method | getParseHtmlTagInCell() | |
method | setParseHtmlTagInCell(value) | |
Parse html tag in cell,like ,as cell value,or as html tag,default is true | ||
method | getPdfExportImagesFolder() | |
method | setPdfExportImagesFolder(value) | |
The physical folder where images will be saved when exporting a workbook to Aspose.Pdf XML format. Default is an empty string. | ||
method | getPresentationPreference() | |
method | setPresentationPreference(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. | ||
method | getRefreshChartCache() | |
method | setRefreshChartCache(value) | |
Indicates whether refreshing chart cache data | ||
method | getSaveAsSingleFile() | |
method | setSaveAsSingleFile(value) | |
Indicates whether save the html as single file. The default value is false. | ||
method | getSaveFormat() | |
Gets the save file format.
The value of the property is SaveFormat integer constant. |
||
method | getSortExternalNames() | |
method | setSortExternalNames(value) | |
Indicates whether sorting external defined names before saving file. | ||
method | getSortNames() | |
method | setSortNames(value) | |
Indicates whether sorting defined names before saving file. | ||
method | getTableCssId() | |
method | setTableCssId(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 "". | ||
method | getUpdateSmartArt() | |
method | setUpdateSmartArt(value) | |
Indicates whether updating smart art setting. The default value is false. | ||
method | getValidateMergedAreas() | |
method | setValidateMergedAreas(value) | |
Indicates whether validate merged cells before saving the file. | ||
method | getWarningCallback() | |
method | setWarningCallback(value) | |
Gets or sets warning callback. | ||
method | getWidthScalable() | |
method | setWidthScalable(value) | |
Indicates whether using scalable unit to describe the column width when exporting file to html. The default value is false. | ||
method | getWorksheetScalable() | |
method | setWorksheetScalable(value) | |
Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false. |
HtmlSaveOptions()
HtmlSaveOptions(format)
format: int
- A boolean getIgnoreInvisibleShapes() / setIgnoreInvisibleShapes(value)
String getPageTitle() / setPageTitle(value)
String getAttachedFilesDirectory() / setAttachedFilesDirectory(value)
String getAttachedFilesUrlPrefix() / setAttachedFilesUrlPrefix(value)
String getDefaultFontName() / setDefaultFontName(value)
boolean getWorksheetScalable() / setWorksheetScalable(value)
boolean isExportComments() / setExportComments(value)
boolean getDisableDownlevelRevealedComments() / setDisableDownlevelRevealedComments(value)
boolean isExpImageToTempDir() / setExpImageToTempDir(value)
boolean getImageScalable() / setImageScalable(value)
boolean getWidthScalable() / setWidthScalable(value)
boolean getExportSingleTab() / setExportSingleTab(value)
boolean getExportImagesAsBase64() / setExportImagesAsBase64(value)
boolean getExportActiveWorksheetOnly() / setExportActiveWorksheetOnly(value)
boolean getExportPrintAreaOnly() / setExportPrintAreaOnly(value)
CellArea getExportArea() / setExportArea(value)
boolean getParseHtmlTagInCell() / setParseHtmlTagInCell(value)
int getHtmlCrossStringType() / setHtmlCrossStringType(value)
int getHiddenColDisplayType() / setHiddenColDisplayType(value)
int getHiddenRowDisplayType() / setHiddenRowDisplayType(value)
Encoding getEncoding() / setEncoding(value)
IExportObjectListener getExportObjectListener() / setExportObjectListener(value)
IFilePathProvider getFilePathProvider() / setFilePathProvider(value)
ImageOrPrintOptions getImageOptions()
boolean getSaveAsSingleFile() / setSaveAsSingleFile(value)
boolean getExportHiddenWorksheet() / setExportHiddenWorksheet(value)
boolean getPresentationPreference() / setPresentationPreference(value)
String getCellCssPrefix() / setCellCssPrefix(value)
String getTableCssId() / setTableCssId(value)
boolean isFullPathLink() / setFullPathLink(value)
boolean getExportWorksheetCSSSeparately() / setExportWorksheetCSSSeparately(value)
boolean getExportSimilarBorderStyle() / setExportSimilarBorderStyle(value)
boolean getMergeEmptyTdForcely() / setMergeEmptyTdForcely(value)
boolean getExportCellCoordinate() / setExportCellCoordinate(value)
boolean getExportExtraHeadings() / setExportExtraHeadings(value)
boolean getExportHeadings() / setExportHeadings(value)
boolean getExportFormula() / setExportFormula(value)
boolean getAddTooltipText() / setAddTooltipText(value)
boolean getExportGridLines() / setExportGridLines(value)
boolean getExportBogusRowData() / setExportBogusRowData(value)
boolean getExcludeUnusedStyles() / setExcludeUnusedStyles(value)
boolean getExportDocumentProperties() / setExportDocumentProperties(value)
boolean getExportWorksheetProperties() / setExportWorksheetProperties(value)
boolean getExportWorkbookProperties() / setExportWorkbookProperties(value)
boolean getExportFrameScriptsAndProperties() / setExportFrameScriptsAndProperties(value)
int getExportDataOptions() / setExportDataOptions(value)
int getLinkTargetType() / setLinkTargetType(value)
int getSaveFormat()
boolean getClearData() / setClearData(value)
String getCachedFileFolder() / setCachedFileFolder(value)
boolean getValidateMergedAreas() / setValidateMergedAreas(value)
boolean getMergeAreas() / setMergeAreas(value)
boolean getCreateDirectory() / setCreateDirectory(value)
boolean getSortNames() / setSortNames(value)
boolean getSortExternalNames() / setSortExternalNames(value)
boolean getRefreshChartCache() / setRefreshChartCache(value)
String getPdfExportImagesFolder() / setPdfExportImagesFolder(value)
boolean getEnableHTTPCompression() / setEnableHTTPCompression(value)
IWarningCallback getWarningCallback() / setWarningCallback(value)
boolean getUpdateSmartArt() / setUpdateSmartArt(value)