com.aspose.cells

Class HtmlSaveOptions

  • java.lang.Object
public class HtmlSaveOptions 
extends SaveOptions

Represents the options for saving html file.

Constructor Summary
HtmlSaveOptions()
Creates options for saving html file.
HtmlSaveOptions(intformat)
Creates options for saving htm file.
 
Property Getters/Setters Summary
java.lang.StringgetAttachedFilesDirectory()
void
setAttachedFilesDirectory(java.lang.Stringvalue)
The directory that the attached files will be saved to. Only for saving to html stream.
java.lang.StringgetAttachedFilesUrlPrefix()
void
setAttachedFilesUrlPrefix(java.lang.Stringvalue)
Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.
java.lang.StringgetCachedFileFolder()
void
setCachedFileFolder(java.lang.Stringvalue)
The cached file folder is used to store some large data.
java.lang.StringgetCellCssPrefix()
void
setCellCssPrefix(java.lang.Stringvalue)
Gets and sets the prefix of the css name,the default value is "".
booleangetClearData()
void
setClearData(booleanvalue)
Make the workbook empty after saving the file.
booleangetCreateDirectory()
void
setCreateDirectory(booleanvalue)
If true and the directory does not exist, the directory will be automatically created before saving the file.
java.lang.StringgetDefaultFontName()
void
setDefaultFontName(java.lang.Stringvalue)
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.
booleangetDisableDownlevelRevealedComments()
void
Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
booleangetEnableHTTPCompression()
void
Indicates if http compression is to be used in user's IIS.
EncodinggetEncoding()
void
If not set,use Encoding.UTF8 as default enconding type.
booleangetExportActiveWorksheetOnly()
void
Indicates if exporting the whole workbook to html file.
booleangetExportBogusRowData()
void
setExportBogusRowData(booleanvalue)
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.
intgetExportDataOptions()
void
Indicating the rule of exporting html file data.The default value is All. The value of the property is HtmlExportDataOptions integer constant.
booleangetExportFrameScriptsAndProperties()
void
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.
booleangetExportGridLines()
void
setExportGridLines(booleanvalue)
Indicating whether export the gridlines.The default value is false.
booleangetExportHiddenWorksheet()
void
Indicating if exporting the hidden worksheet content.The default value is true.
booleangetExportImagesAsBase64()
void
Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
IExportObjectListenergetExportObjectListener()
void
Gets or sets the ExportObjectListener for exporting objects.
IFilePathProvidergetFilePathProvider()
void
Gets or sets the IFilePathProvider for exporting Worksheet to html separately.
intgetHiddenColDisplayType()
void
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.
intgetHiddenRowDisplayType()
void
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.
intgetHtmlCrossStringType()
void
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.
ImageOrPrintOptionsgetImageOptions()
Get the ImageOrPrintOptions object before exporting
booleanisExpImageToTempDir()
void
setExpImageToTempDir(booleanvalue)
Indicates if export image files to temp directory. Only for saving to html stream.
booleanisExportComments()
void
setExportComments(booleanvalue)
Indicates if exporting comments when saving file to html, the default value is false.
booleanisFullPathLink()
void
setFullPathLink(booleanvalue)
Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false.
intgetLinkTargetType()
void
Indicating the type of target attribute in <a> link,The default value is HtmlLinkTargetType.Parent. The value of the property is HtmlLinkTargetType integer constant.
booleangetMergeAreas()
void
setMergeAreas(booleanvalue)
Indicates whether merge the areas of conditional formatting and validation before saving the file.
java.lang.StringgetPageTitle()
void
setPageTitle(java.lang.Stringvalue)
The title of the html page. Only for saving to html stream.
booleangetParseHtmlTagInCell()
void
setParseHtmlTagInCell(booleanvalue)
Parse html tag in cell,like
,as cell value,or as html tag,default is true
java.lang.StringgetPdfExportImagesFolder()
void
setPdfExportImagesFolder(java.lang.Stringvalue)
The physical folder where images will be saved when exporting a workbook to Aspose.Pdf XML format. Default is an empty string.
booleangetPresentationPreference()
void
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.
booleangetRefreshChartCache()
void
setRefreshChartCache(booleanvalue)
Indicates whether refreshing chart cache data
intgetSaveFormat()
Gets the save file format. The value of the property is SaveFormat integer constant.
booleangetSortNames()
void
setSortNames(booleanvalue)
Indicates whether sorting defined names before saving file.
IStreamProvidergetStreamProvider()
void
Gets or sets the IStreamProvider for exporting objects.
booleangetValidateMergedAreas()
void
Indicates whether validate merged cells before saving the file.
IWarningCallbackgetWarningCallback()
void
Gets or sets warning callback.
 

    • Constructor Detail

      • 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.
    • Property Getters/Setters Detail

      • getPageTitle/setPageTitle

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

        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.
      • getAttachedFilesUrlPrefix/setAttachedFilesUrlPrefix

        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.
      • getDefaultFontName/setDefaultFontName

        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.
      • isExportComments/setExportComments

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

        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.
      • isExpImageToTempDir/setExpImageToTempDir

        public boolean isExpImageToTempDir() / public void setExpImageToTempDir(boolean value)
        
        Indicates if export image files to temp directory. Only for saving to html stream.
      • getExportImagesAsBase64/setExportImagesAsBase64

        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.
      • getExportActiveWorksheetOnly/setExportActiveWorksheetOnly

        public boolean getExportActiveWorksheetOnly() / public void setExportActiveWorksheetOnly(boolean value)
        
        Indicates if exporting the whole workbook to html file.
      • getParseHtmlTagInCell/setParseHtmlTagInCell

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

        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.
      • getHiddenColDisplayType/setHiddenColDisplayType

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

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

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

        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.
      • getFilePathProvider/setFilePathProvider

        public IFilePathProvider getFilePathProvider() / public void setFilePathProvider(IFilePathProvider value)
        
        Gets or sets the IFilePathProvider for exporting Worksheet to html separately.
      • getStreamProvider/setStreamProvider

        public IStreamProvider getStreamProvider() / public void setStreamProvider(IStreamProvider value)
        
        Gets or sets the IStreamProvider for exporting objects.
      • getImageOptions

        public ImageOrPrintOptions getImageOptions()
        
        Get the ImageOrPrintOptions object before exporting
      • getExportHiddenWorksheet/setExportHiddenWorksheet

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

        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.
      • getCellCssPrefix/setCellCssPrefix

        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 "".
      • isFullPathLink/setFullPathLink

        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.
      • getExportGridLines/setExportGridLines

        public boolean getExportGridLines() / public void setExportGridLines(boolean value)
        
        Indicating whether export the gridlines.The default value is false.
      • getExportBogusRowData/setExportBogusRowData

        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.
      • getExportFrameScriptsAndProperties/setExportFrameScriptsAndProperties

        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.
      • getExportDataOptions/setExportDataOptions

        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.
      • getLinkTargetType/setLinkTargetType

        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.
      • getSaveFormat

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

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

        public java.lang.String getCachedFileFolder() / public void setCachedFileFolder(java.lang.String value)
        
        The cached file folder is used to store some large data.
      • getValidateMergedAreas/setValidateMergedAreas

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

        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.
      • getCreateDirectory/setCreateDirectory

        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.
      • getSortNames/setSortNames

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

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

        public java.lang.String getPdfExportImagesFolder() / public void setPdfExportImagesFolder(java.lang.String 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

        public boolean getEnableHTTPCompression() / public void setEnableHTTPCompression(boolean 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

        public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)
        
        Gets or sets warning callback.