asposecells.api

Class HtmlSaveOptions

Represents the options for saving html file.

Constructor Summary
HtmlSaveOptions()
Creates options for saving html file.
HtmlSaveOptions(format)
Creates options for saving htm file.
 
Property Getters/Setters Summary
methodgetAddTooltipText()
method
           Indicates whether adding tooltip text when the data can't be fully displayed. The default value is false.
methodgetAttachedFilesDirectory()
method
           The directory that the attached files will be saved to. Only for saving to html stream.
methodgetAttachedFilesUrlPrefix()
method
           Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.
methodgetCachedFileFolder()
method
           The cached file folder is used to store some large data.
methodgetCellCssPrefix()
method
           Gets and sets the prefix of the css name,the default value is "".
methodgetClearData()
method
           Make the workbook empty after saving the file.
methodgetCreateDirectory()
method
           If true and the directory does not exist, the directory will be automatically created before saving the file.
methodgetDefaultFontName()
method
           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.
methodgetDisableDownlevelRevealedComments()
method
           Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
methodgetEnableHTTPCompression()
method
           Indicates if http compression is to be used in user's IIS.
methodgetEncoding()
method
           If not set,use Encoding.UTF8 as default enconding type.
methodgetExcludeUnusedStyles()
method
           Indicating whether excluding unused styles.The default value is false.If you want to import the html or mht file to excel, please keep the default value.
methodgetExportActiveWorksheetOnly()
method
           Indicates if exporting the whole workbook to html file.
methodgetExportArea()
method
           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.
methodgetExportBogusRowData()
method
           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.
methodgetExportCellCoordinate()
method
           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.
methodgetExportDataOptions()
method
           Indicating the rule of exporting html file data.The default value is All. The value of the property is HtmlExportDataOptions integer constant.
methodgetExportDocumentProperties()
method
           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.
methodgetExportExtraHeadings()
method
           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.
methodgetExportFormula()
method
           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.
methodgetExportFrameScriptsAndProperties()
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.
methodgetExportGridLines()
method
           Indicating whether exporting the gridlines.The default value is false.
methodgetExportHeadings()
method
           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.
methodgetExportHiddenWorksheet()
method
           Indicating if exporting the hidden worksheet content.The default value is true.
methodgetExportImagesAsBase64()
method
           Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
methodgetExportObjectListener()
method
           Gets or sets the ExportObjectListener for exporting objects.
methodgetExportPrintAreaOnly()
method
           Indicates if only exporting the print area to html file. The default value is false.
methodgetExportSimilarBorderStyle()
method
           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.
methodgetExportSingleTab()
method
           Indicates whether exporting the single tab when the file only has one worksheet. The default value is false.
methodgetExportWorkbookProperties()
method
           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.
methodgetExportWorksheetCSSSeparately()
method
           Indicating whether export the worksheet css separately.The default value is false.
methodgetExportWorksheetProperties()
method
           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.
methodgetFilePathProvider()
method
           Gets or sets the IFilePathProvider for exporting Worksheet to html separately.
methodgetHiddenColDisplayType()
method
           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.
methodgetHiddenRowDisplayType()
method
           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.
methodgetHtmlCrossStringType()
method
           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.
methodgetImageOptions()
Get the ImageOrPrintOptions object before exporting
methodgetImageScalable()
method
           Indicates whether using scalable unit to describe the image width when using scalable unit to describe the column width. The default value is true.
methodisExpImageToTempDir()
method
           Indicates whether exporting image files to temp directory. Only for saving to html stream.
methodisExportComments()
method
           Indicates if exporting comments when saving file to html, the default value is false.
methodisFullPathLink()
method
           Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false.
methodgetLinkTargetType()
method
           Indicating the type of target attribute in <a> link,The default value is HtmlLinkTargetType.Parent. The value of the property is HtmlLinkTargetType integer constant.
methodgetMergeAreas()
method
           Indicates whether merge the areas of conditional formatting and validation before saving the file.
methodgetMergeEmptyTdForcely()
method
           Indicates whether merging empty TD element forcely 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.
methodgetPageTitle()
method
           The title of the html page. Only for saving to html stream.
methodgetParseHtmlTagInCell()
method
           Parse html tag in cell,like
,as cell value,or as html tag,default is true
methodgetPdfExportImagesFolder()
method
           The physical folder where images will be saved when exporting a workbook to Aspose.Pdf XML format. Default is an empty string.
methodgetPresentationPreference()
method
           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.
methodgetRefreshChartCache()
method
           Indicates whether refreshing chart cache data
methodgetSaveFormat()
Gets the save file format. The value of the property is SaveFormat integer constant.
methodgetSortExternalNames()
method
           Indicates whether sorting external defined names before saving file.
methodgetSortNames()
method
           Indicates whether sorting defined names before saving file.
methodgetTableCssId()
method
           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 "".
methodgetUpdateSmartArt()
method
           Indicates whether updating smart art setting. The default value is false.
methodgetValidateMergedAreas()
method
           Indicates whether validate merged cells before saving the file.
methodgetWarningCallback()
method
           Gets or sets warning callback.
methodgetWidthScalable()
method
           Indicates whether using scalable unit to describe the column width when exporting file to html. The default value is false.
 

    • Constructor Detail

      • HtmlSaveOptions

        HtmlSaveOptions()
        Creates options for saving html file.
      • HtmlSaveOptions

        HtmlSaveOptions(format)
        Creates options for saving htm file.
        Parameters:
        format: int - A SaveFormat value. The saving file format.
    • Property Getters/Setters Detail

      • getPageTitle/setPageTitle : String 

        String getPageTitle() / setPageTitle(value)
        
        The title of the html page. Only for saving to html stream.
      • getAttachedFilesDirectory/setAttachedFilesDirectory : String 

        String getAttachedFilesDirectory() / setAttachedFilesDirectory(value)
        
        The directory that the attached files will be saved to. Only for saving to html stream.
      • getAttachedFilesUrlPrefix/setAttachedFilesUrlPrefix : String 

        String getAttachedFilesUrlPrefix() / setAttachedFilesUrlPrefix(value)
        
        Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.
      • getDefaultFontName/setDefaultFontName : String 

        String getDefaultFontName() / 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.
      • isExportComments/setExportComments : boolean 

        boolean isExportComments() / setExportComments(value)
        
        Indicates if exporting comments when saving file to html, the default value is false.
      • getDisableDownlevelRevealedComments/setDisableDownlevelRevealedComments : boolean 

        boolean getDisableDownlevelRevealedComments() / setDisableDownlevelRevealedComments(value)
        
        Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
      • isExpImageToTempDir/setExpImageToTempDir : boolean 

        boolean isExpImageToTempDir() / setExpImageToTempDir(value)
        
        Indicates whether exporting image files to temp directory. Only for saving to html stream.
      • getImageScalable/setImageScalable : boolean 

        boolean getImageScalable() / 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.
      • getWidthScalable/setWidthScalable : boolean 

        boolean getWidthScalable() / setWidthScalable(value)
        
        Indicates whether using scalable unit to describe the column width when exporting file to html. The default value is false.
      • getExportSingleTab/setExportSingleTab : boolean 

        boolean getExportSingleTab() / setExportSingleTab(value)
        
        Indicates whether exporting the single tab when the file only has one worksheet. The default value is false.
      • getExportImagesAsBase64/setExportImagesAsBase64 : boolean 

        boolean getExportImagesAsBase64() / setExportImagesAsBase64(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.
      • getExportActiveWorksheetOnly/setExportActiveWorksheetOnly : boolean 

        boolean getExportActiveWorksheetOnly() / setExportActiveWorksheetOnly(value)
        
        Indicates if exporting the whole workbook to html file.
      • getExportPrintAreaOnly/setExportPrintAreaOnly : boolean 

        boolean getExportPrintAreaOnly() / setExportPrintAreaOnly(value)
        
        Indicates if only exporting the print area to html file. The default value is false.
      • getExportArea/setExportArea : CellArea 

        CellArea getExportArea() / 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.
      • getParseHtmlTagInCell/setParseHtmlTagInCell : boolean 

        boolean getParseHtmlTagInCell() / setParseHtmlTagInCell(value)
        
        Parse html tag in cell,like
        ,as cell value,or as html tag,default is true
      • getHtmlCrossStringType/setHtmlCrossStringType : int 

        int getHtmlCrossStringType() / 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.
      • getHiddenColDisplayType/setHiddenColDisplayType : int 

        int getHiddenColDisplayType() / 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.
      • getHiddenRowDisplayType/setHiddenRowDisplayType : int 

        int getHiddenRowDisplayType() / 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.
      • getEncoding/setEncoding : Encoding 

        Encoding getEncoding() / setEncoding(value)
        
        If not set,use Encoding.UTF8 as default enconding type.
      • getExportObjectListener/setExportObjectListener : IExportObjectListener 

        IExportObjectListener getExportObjectListener() / setExportObjectListener(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.
      • getFilePathProvider/setFilePathProvider : IFilePathProvider 

        IFilePathProvider getFilePathProvider() / setFilePathProvider(value)
        
        Gets or sets the IFilePathProvider for exporting Worksheet to html separately.
      • getExportHiddenWorksheet/setExportHiddenWorksheet : boolean 

        boolean getExportHiddenWorksheet() / setExportHiddenWorksheet(value)
        
        Indicating if exporting the hidden worksheet content.The default value is true.
      • getPresentationPreference/setPresentationPreference : boolean 

        boolean getPresentationPreference() / 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.
      • getCellCssPrefix/setCellCssPrefix : String 

        String getCellCssPrefix() / setCellCssPrefix(value)
        
        Gets and sets the prefix of the css name,the default value is "".
      • getTableCssId/setTableCssId : String 

        String getTableCssId() / 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 "".
      • isFullPathLink/setFullPathLink : boolean 

        boolean isFullPathLink() / setFullPathLink(value)
        
        Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false.
      • getExportWorksheetCSSSeparately/setExportWorksheetCSSSeparately : boolean 

        boolean getExportWorksheetCSSSeparately() / setExportWorksheetCSSSeparately(value)
        
        Indicating whether export the worksheet css separately.The default value is false.
      • getExportSimilarBorderStyle/setExportSimilarBorderStyle : boolean 

        boolean getExportSimilarBorderStyle() / 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.
      • getMergeEmptyTdForcely/setMergeEmptyTdForcely : boolean 

        boolean getMergeEmptyTdForcely() / setMergeEmptyTdForcely(value)
        
        Indicates whether merging empty TD element forcely 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.
      • getExportCellCoordinate/setExportCellCoordinate : boolean 

        boolean getExportCellCoordinate() / 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.
      • getExportExtraHeadings/setExportExtraHeadings : boolean 

        boolean getExportExtraHeadings() / 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.
      • getExportHeadings/setExportHeadings : boolean 

        boolean getExportHeadings() / 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.
      • getExportFormula/setExportFormula : boolean 

        boolean getExportFormula() / 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.
      • getAddTooltipText/setAddTooltipText : boolean 

        boolean getAddTooltipText() / setAddTooltipText(value)
        
        Indicates whether adding tooltip text when the data can't be fully displayed. The default value is false.
      • getExportGridLines/setExportGridLines : boolean 

        boolean getExportGridLines() / setExportGridLines(value)
        
        Indicating whether exporting the gridlines.The default value is false.
      • getExportBogusRowData/setExportBogusRowData : boolean 

        boolean getExportBogusRowData() / 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.
      • getExcludeUnusedStyles/setExcludeUnusedStyles : boolean 

        boolean getExcludeUnusedStyles() / setExcludeUnusedStyles(value)
        
        Indicating whether excluding unused styles.The default value is false.If you want to import the html or mht file to excel, please keep the default value.
      • getExportDocumentProperties/setExportDocumentProperties : boolean 

        boolean getExportDocumentProperties() / 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.
      • getExportWorksheetProperties/setExportWorksheetProperties : boolean 

        boolean getExportWorksheetProperties() / 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.
      • getExportWorkbookProperties/setExportWorkbookProperties : boolean 

        boolean getExportWorkbookProperties() / 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.
      • getExportFrameScriptsAndProperties/setExportFrameScriptsAndProperties : boolean 

        boolean getExportFrameScriptsAndProperties() / setExportFrameScriptsAndProperties(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.
      • getExportDataOptions/setExportDataOptions : int 

        int getExportDataOptions() / setExportDataOptions(value)
        
        Indicating the rule of exporting html file data.The default value is All. The value of the property is HtmlExportDataOptions integer constant.
      • getLinkTargetType/setLinkTargetType : int 

        int getLinkTargetType() / 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.
      • getSaveFormat : int 

        int getSaveFormat()
        
        Gets the save file format. The value of the property is SaveFormat integer constant.
      • getClearData/setClearData : boolean 

        boolean getClearData() / setClearData(value)
        
        Make the workbook empty after saving the file.
      • getCachedFileFolder/setCachedFileFolder : String 

        String getCachedFileFolder() / setCachedFileFolder(value)
        
        The cached file folder is used to store some large data.
      • getValidateMergedAreas/setValidateMergedAreas : boolean 

        boolean getValidateMergedAreas() / setValidateMergedAreas(value)
        
        Indicates whether validate merged cells before saving the file. The default value is false.
      • getMergeAreas/setMergeAreas : boolean 

        boolean getMergeAreas() / setMergeAreas(value)
        
        Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is false.
      • getCreateDirectory/setCreateDirectory : boolean 

        boolean getCreateDirectory() / setCreateDirectory(value)
        
        If true and the directory does not exist, the directory will be automatically created before saving the file. The default value is false.
      • getSortNames/setSortNames : boolean 

        boolean getSortNames() / setSortNames(value)
        
        Indicates whether sorting defined names before saving file.
      • getSortExternalNames/setSortExternalNames : boolean 

        boolean getSortExternalNames() / setSortExternalNames(value)
        
        Indicates whether sorting external defined names before saving file.
      • getRefreshChartCache/setRefreshChartCache : boolean 

        boolean getRefreshChartCache() / setRefreshChartCache(value)
        
        Indicates whether refreshing chart cache data
      • getPdfExportImagesFolder/setPdfExportImagesFolder : String 

        String getPdfExportImagesFolder() / setPdfExportImagesFolder(value)
        
        The physical folder where images will be saved when exporting a workbook to Aspose.Pdf XML format. Default is an empty string.
      • getEnableHTTPCompression/setEnableHTTPCompression : boolean 

        boolean getEnableHTTPCompression() / setEnableHTTPCompression(value)
        
        Indicates if http compression is to be used in user's IIS. Please specify this property to true if http compression is used.
      • getWarningCallback/setWarningCallback : IWarningCallback 

        IWarningCallback getWarningCallback() / setWarningCallback(value)
        
        Gets or sets warning callback.
      • getUpdateSmartArt/setUpdateSmartArt : boolean 

        boolean getUpdateSmartArt() / setUpdateSmartArt(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.