aspose.cells

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
functiongetAttachedFilesDirectory()
function
           The directory that the attached files will be saved to. Only for saving to html stream.
functiongetAttachedFilesUrlPrefix()
function
           Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.
functiongetCachedFileFolder()
function
           The cached file folder is used to store some large data.
functiongetCellCssPrefix()
function
           Gets and sets the prefix of the css name,the default value is "".
functiongetClearData()
function
           Make the workbook empty after saving the file.
functiongetCreateDirectory()
function
           If true and the directory does not exist, the directory will be automatically created before saving the file.
functiongetDefaultFontName()
function
           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.
functiongetDisableDownlevelRevealedComments()
function
           Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
functiongetEnableHTTPCompression()
function
           Indicates if http compression is to be used in user's IIS.
functiongetEncoding()
function
           If not set,use Encoding.UTF8 as default enconding type.
functiongetExcludeUnusedStyles()
function
           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.
functiongetExportActiveWorksheetOnly()
function
           Indicates if exporting the whole workbook to html file.
functiongetExportBogusRowData()
function
           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.
functiongetExportDataOptions()
function
           Indicating the rule of exporting html file data.The default value is All. The value of the property is HtmlExportDataOptions integer constant.
functiongetExportDocumentProperties()
function
           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.
functiongetExportFrameScriptsAndProperties()
function
           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.
functiongetExportGridLines()
function
           Indicating whether exporting the gridlines.The default value is false.
functiongetExportHiddenWorksheet()
function
           Indicating if exporting the hidden worksheet content.The default value is true.
functiongetExportImagesAsBase64()
function
           Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
functiongetExportObjectListener()
function
           Gets or sets the ExportObjectListener for exporting objects.
functiongetExportPrintAreaOnly()
function
           Indicates if only exporting the print area to html file. The default value is false.
functiongetExportSimilarBorderStyle()
function
           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.
functiongetExportSingleTab()
function
           Indicates whether exporting the single tab when the file only has one worksheet. The default value is false.
functiongetExportWorkbookProperties()
function
           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.
functiongetExportWorksheetCSSSeparately()
function
           Indicating whether export the worksheet css separately.The default value is false.
functiongetExportWorksheetProperties()
function
           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.
functiongetFilePathProvider()
function
           Gets or sets the IFilePathProvider for exporting Worksheet to html separately.
functiongetHiddenColDisplayType()
function
           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 ont 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.
functiongetHiddenRowDisplayType()
function
           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 ont 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.
functiongetHtmlCrossStringType()
function
           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.
functiongetImageOptions()
Get the ImageOrPrintOptions object before exporting
functionisExpImageToTempDir()
function
           Indicates whether exporting image files to temp directory. Only for saving to html stream.
functionisExportComments()
function
           Indicates if exporting comments when saving file to html, the default value is false.
functionisFullPathLink()
function
           Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false.
functiongetLinkTargetType()
function
           Indicating the type of target attribute in <a> link,The default value is HtmlLinkTargetType.Parent. The value of the property is HtmlLinkTargetType integer constant.
functiongetMergeAreas()
function
           Indicates whether merge the areas of conditional formatting and validation before saving the file.
functiongetPageTitle()
function
           The title of the html page. Only for saving to html stream.
functiongetParseHtmlTagInCell()
function
           Parse html tag in cell,like
,as cell value,or as html tag,default is true
functiongetPdfExportImagesFolder()
function
           The physical folder where images will be saved when exporting a workbook to Aspose.Pdf XML format. Default is an empty string.
functiongetPresentationPreference()
function
           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.
functiongetRefreshChartCache()
function
           Indicates whether refreshing chart cache data
functiongetSaveFormat()
Gets the save file format. The value of the property is SaveFormat integer constant.
functiongetSortNames()
function
           Indicates whether sorting defined names before saving file.
functiongetTableCssId()
function
           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 "".
functiongetValidateMergedAreas()
function
           Indicates whether validate merged cells before saving the file.
functiongetWarningCallback()
function
           Gets or sets warning callback.
functiongetWidthScalable()
function
           Indicates whether using scalable unit to describe the column width when exporting file to html. The default value is false.
 

    • Constructor Detail

      • HtmlSaveOptions

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

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

      • getPageTitle/setPageTitle : String 

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

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

        function getAttachedFilesUrlPrefix() / function 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 

        function getDefaultFontName() / function 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 

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

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

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

        function getWidthScalable() / function 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 

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

        function getExportImagesAsBase64() / function 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 

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

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

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

        function getHtmlCrossStringType() / function 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 : Number 

        function getHiddenColDisplayType() / function 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 ont 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 : Number 

        function getHiddenRowDisplayType() / function 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 ont 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 

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

        function getExportObjectListener() / function 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 

        function getFilePathProvider() / function setFilePathProvider(value)
        
        Gets or sets the IFilePathProvider for exporting Worksheet to html separately.
      • getImageOptions : ImageOrPrintOptions 

        function getImageOptions()
        
        Get the ImageOrPrintOptions object before exporting
      • getExportHiddenWorksheet/setExportHiddenWorksheet : boolean 

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

        function getPresentationPreference() / function 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 

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

        function getTableCssId() / function 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 

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

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

        function getExportSimilarBorderStyle() / function 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.
      • getExportGridLines/setExportGridLines : boolean 

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

        function getExportBogusRowData() / function 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 

        function getExcludeUnusedStyles() / function 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 

        function getExportDocumentProperties() / function 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 

        function getExportWorksheetProperties() / function 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 

        function getExportWorkbookProperties() / function 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 

        function getExportFrameScriptsAndProperties() / function 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 : Number 

        function getExportDataOptions() / function 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 : Number 

        function getLinkTargetType() / function 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 : Number 

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

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

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

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

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

        function getCreateDirectory() / function 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 

        function getSortNames() / function setSortNames(value)
        
        Indicates whether sorting defined names before saving file.
      • getRefreshChartCache/setRefreshChartCache : boolean 

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

        function getPdfExportImagesFolder() / function 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 

        function getEnableHTTPCompression() / function 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 

        function getWarningCallback() / function setWarningCallback(value)
        
        Gets or sets warning callback.