com.aspose.cells
Class HtmlSaveOptions

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

public class HtmlSaveOptions 
extends SaveOptions

Represents the options for saving html file.

Constructor Summary
HtmlSaveOptions()
           Creates options for saving html file.
HtmlSaveOptions(int format)
           Creates options for saving htm file.
 
Property Getters/Setters Summary
java.lang.StringgetAttachedFilesDirectory()
voidsetAttachedFilesDirectory(java.lang.String value)
           The directory that the attached files will be saved to. Only for saving to html stream.
java.lang.StringgetAttachedFilesUrlPrefix()
voidsetAttachedFilesUrlPrefix(java.lang.String value)
           Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.
java.lang.StringgetCachedFileFolder()→ inherited from SaveOptions
voidsetCachedFileFolder(java.lang.String value)
           The cached file folder is used to store some large data.
booleangetClearData()→ inherited from SaveOptions
voidsetClearData(boolean value)
           Make the workbook empty after saving the file.
intgetCompliance()→ inherited from SaveOptions
voidsetCompliance(int value)
           Workbook converts to pdf will according to PdfCompliance in this property. The value of the property is PdfCompliance integer constant.
booleangetCreateDirectory()→ inherited from SaveOptions
voidsetCreateDirectory(boolean value)
           If true and the directory does not exist, the directory will be automatically created before saving the file.
java.lang.StringgetDefaultFont()→ inherited from SaveOptions
voidsetDefaultFont(java.lang.String value)
           When characters in the Excel are unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set the DefaultFont such as MingLiu or MS Gothic to show these characters. If this property is not set, Aspose.Cells will use system default font to show these unicode characters.
booleangetDisplayHTMLCrossString()
voidsetDisplayHTMLCrossString(boolean 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 true, 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 would be several times faster than setting the value to false.
booleangetEnableHTTPCompression()→ inherited from SaveOptions
voidsetEnableHTTPCompression(boolean value)
           Indicates if http compression is to be used in user's IIS.
com.aspose.cells.EncodinggetEncoding()
voidsetEncoding(com.aspose.cells.Encoding value)
           If not set,use Encoding.UTF8 as default enconding type.
booleangetExpCellNameToXLSX()→ inherited from SaveOptions
voidsetExpCellNameToXLSX(boolean value)
           Indicates if export cell name to Excel2007 .xlsx (.xlsm, .xltx, .xltm) file. If the output file may be accessed by SQL Server DTS, this value must be true. Setting the value to false will highly increase the performance and reduce the file size when creating large file. Default value is false.
booleangetExportActiveWorksheetOnly()
voidsetExportActiveWorksheetOnly(boolean value)
           Indicates if exporting the whole workbook to html file.
com.aspose.cells.ImageFormatgetExportChartImageFormat()
voidsetExportChartImageFormat(com.aspose.cells.ImageFormat value)
           Get or set the format of chart image before exporting
booleangetExportImagesAsBase64()
voidsetExportImagesAsBase64(boolean value)
           Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
IExportObjectListenergetExportObjectListener()
voidsetExportObjectListener(IExportObjectListener value)
           Gets or sets the ExportObjectListener for exporting objects.
IStreamProvidergetExportProviderFile()
voidsetExportProviderFile(IStreamProvider value)
           Gets or sets the IStreamProvider for exporting objects.
intgetHiddenColDisplayType()
voidsetHiddenColDisplayType(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.
intgetHiddenRowDisplayType()
voidsetHiddenRowDisplayType(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.
intgetHtmlCrossStringType()
voidsetHtmlCrossStringType(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.
booleanisExpImageToTempDir()
voidsetExpImageToTempDir(boolean value)
           Indicates if export image files to temp directory. Only for saving to html stream.
java.lang.StringgetPageTitle()
voidsetPageTitle(java.lang.String value)
           The title of the html page. Only for saving to html stream.
booleangetParseHtmlTagInCell()
voidsetParseHtmlTagInCell(boolean value)
           Parse html tag in cell,like
,as cell value,or as html tag,default is true
PdfBookmarkEntrygetPdfBookmark()→ inherited from SaveOptions
voidsetPdfBookmark(PdfBookmarkEntry value)
           Gets and sets the PdfBookmarkEntry object.
java.lang.StringgetPdfExportImagesFolder()→ inherited from SaveOptions
voidsetPdfExportImagesFolder(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.
booleangetRefreshChartCache()→ inherited from SaveOptions
voidsetRefreshChartCache(boolean value)
           Indicates whether refreshing chart cache data
intgetSaveFormat()→ inherited from SaveOptions
           Gets the save file format. The value of the property is SaveFormat integer constant.
booleangetSortNames()→ inherited from SaveOptions
voidsetSortNames(boolean value)
           Indicates whether sorting defined names before saving file.
booleangetValidateMergedAreas()→ inherited from SaveOptions
voidsetValidateMergedAreas(boolean value)
           Indicates whether validate merged areas before saving the file.
 

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.

getDisplayHTMLCrossString/setDisplayHTMLCrossString

public boolean getDisplayHTMLCrossString() / public void setDisplayHTMLCrossString(boolean 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 true, 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 would be several times faster than setting the value to false. NOTE: This member is now obsolete. Instead, please use HtmlSaveOptions.HtmlCrossStringType property. This property will be removed 12 months later since February 2012. Aspose apologizes for any inconvenience you may have experienced.

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 com.aspose.cells.Encoding getEncoding() / public void setEncoding(com.aspose.cells.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.

getExportProviderFile/setExportProviderFile

public IStreamProvider getExportProviderFile() / public void setExportProviderFile(IStreamProvider value)
Gets or sets the IStreamProvider for exporting objects.

getExportChartImageFormat/setExportChartImageFormat

public com.aspose.cells.ImageFormat getExportChartImageFormat() / public void setExportChartImageFormat(com.aspose.cells.ImageFormat value)
Get or set the format of chart image before exporting

getSaveFormat

→ inherited from SaveOptions
public int getSaveFormat()
Gets the save file format. The value of the property is SaveFormat integer constant.

getExpCellNameToXLSX/setExpCellNameToXLSX

→ inherited from SaveOptions
public boolean getExpCellNameToXLSX() / public void setExpCellNameToXLSX(boolean value)
Indicates if export cell name to Excel2007 .xlsx (.xlsm, .xltx, .xltm) file. If the output file may be accessed by SQL Server DTS, this value must be true. Setting the value to false will highly increase the performance and reduce the file size when creating large file. Default value is false. NOTE: This member is now obsolete. Instead, please use OoxmlSaveOptions.ExportCellName property. This property will be removed 12 months later since July 2010. Aspose apologizes for any inconvenience you may have experienced.

getClearData/setClearData

→ inherited from SaveOptions
public boolean getClearData() / public void setClearData(boolean value)
Make the workbook empty after saving the file.

getCachedFileFolder/setCachedFileFolder

→ inherited from SaveOptions
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

→ inherited from SaveOptions
public boolean getValidateMergedAreas() / public void setValidateMergedAreas(boolean value)
Indicates whether validate merged areas before saving the file. The default value is false.

getCreateDirectory/setCreateDirectory

→ inherited from SaveOptions
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

→ inherited from SaveOptions
public boolean getSortNames() / public void setSortNames(boolean value)
Indicates whether sorting defined names before saving file.

getRefreshChartCache/setRefreshChartCache

→ inherited from SaveOptions
public boolean getRefreshChartCache() / public void setRefreshChartCache(boolean value)
Indicates whether refreshing chart cache data

getDefaultFont/setDefaultFont

→ inherited from SaveOptions
public java.lang.String getDefaultFont() / public void setDefaultFont(java.lang.String value)
When characters in the Excel are unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set the DefaultFont such as MingLiu or MS Gothic to show these characters. If this property is not set, Aspose.Cells will use system default font to show these unicode characters. NOTE: This member is now obsolete. Instead, please use PdfSaveOptions.DefaultFont property. This property will be removed 12 months later since July 2010. Aspose apologizes for any inconvenience you may have experienced.

getCompliance/setCompliance

→ inherited from SaveOptions
public int getCompliance() / public void setCompliance(int value)
Workbook converts to pdf will according to PdfCompliance in this property. The value of the property is PdfCompliance integer constant.NOTE: This member is now obsolete. Instead, please use PdfSaveOptions.Compliance property. This property will be removed 12 months later since July 2010. Aspose apologizes for any inconvenience you may have experienced.

getPdfBookmark/setPdfBookmark

→ inherited from SaveOptions
public PdfBookmarkEntry getPdfBookmark() / public void setPdfBookmark(PdfBookmarkEntry value)
Gets and sets the PdfBookmarkEntry object. NOTE: This member is now obsolete. Instead, please use PdfSaveOptions.Bookmark property. This property will be removed 12 months later since July 2010. Aspose apologizes for any inconvenience you may have experienced.

getPdfExportImagesFolder/setPdfExportImagesFolder

→ inherited from SaveOptions
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

→ inherited from SaveOptions
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.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.