com.aspose.gridweb
Class GridHtmlSaveOptions

java.lang.Object
  extended by GridSaveOptions
      extended by com.aspose.gridweb.GridHtmlSaveOptions

public class GridHtmlSaveOptions 
extends GridSaveOptions

Represents the options for saving html file.


Constructor Summary
GridHtmlSaveOptions()
           Creates options for saving html file.
 
Property Getters/Setters Summary
java.lang.StringgetAttachedFilesDirectory()
voidsetAttachedFilesDirectory(java.lang.String)
           The directory that the attached files will be saved to. Only for saving to html stream.
java.lang.StringgetAttachedFilesUrlPrefix()
voidsetAttachedFilesUrlPrefix(java.lang.String)
           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 GridSaveOptions
voidsetCachedFileFolder(java.lang.String)
           The cached file folder is used to store some large data.
booleangetClearData()→ inherited from GridSaveOptions
voidsetClearData(boolean)
           Make the workbook empty after saving the file.
booleangetCreateDirectory()→ inherited from GridSaveOptions
voidsetCreateDirectory(boolean)
           If true and the directory does not exist, the directory will be automatically created before saving the file.
java.lang.StringgetDefaultFontName()
voidsetDefaultFontName(java.lang.String)
           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.
com.aspose.cells.EncodinggetEncoding()
           If not set,use Encoding.UTF8 as default enconding type.
booleangetExportActiveWorksheetOnly()
voidsetExportActiveWorksheetOnly(boolean)
           Indicates if exporting the whole workbook to html file.
GridCellAreagetExportArea()
voidsetExportArea(GridCellArea)
           Gets or Sets the exporting CellArea of current active Worksheet. If you set this attribute, the print area of current active Worksheet will be omited. Only the specified area will be exported when saving the file to html.
booleangetExportGridLines()
voidsetExportGridLines(boolean)
           Indicating whether exporting the gridlines.The default value is false.
booleangetExportHeadings()
voidsetExportHeadings(boolean)
           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.
booleangetExportHiddenWorksheet()
voidsetExportHiddenWorksheet(boolean)
           Indicating if exporting the hidden worksheet content.The default value is true.
booleangetExportImagesAsBase64()
voidsetExportImagesAsBase64(boolean)
           Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
booleangetExportPrintAreaOnly()
voidsetExportPrintAreaOnly(boolean)
           Indicates if only exporting the print area to html file. The default value is false.
booleangetExportSingleTab()
voidsetExportSingleTab(boolean)
           Indicates whether exporting the single tab when the file only has one worksheet. The default value is false.
booleanisExportComments()
voidsetExportComments(boolean)
           Indicates if exporting comments when saving file to html, the default value is false.
booleanisFullPathLink()
voidsetFullPathLink(boolean)
           Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false.
booleangetMergeAreas()→ inherited from GridSaveOptions
voidsetMergeAreas(boolean)
           Indicates whether merge the areas of conditional formatting and validation before saving the file.
java.lang.StringgetPageTitle()
voidsetPageTitle(java.lang.String)
           The title of the html page. Only for saving to html stream.
booleangetParseHtmlTagInCell()
voidsetParseHtmlTagInCell(boolean)
           Parse html tag in cell,like
,as cell value,or as html tag,default is true
booleangetPresentationPreference()
voidsetPresentationPreference(boolean)
           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()→ inherited from GridSaveOptions
voidsetRefreshChartCache(boolean)
           Indicates whether refreshing chart cache data
com.aspose.gridweb.GridSaveFormatgetSaveFormat()→ inherited from GridSaveOptions
           Gets the save file format.
booleangetSortNames()→ inherited from GridSaveOptions
voidsetSortNames(boolean)
           Indicates whether sorting defined names before saving file.
booleangetValidateMergedAreas()→ inherited from GridSaveOptions
voidsetValidateMergedAreas(boolean)
           Indicates whether validate merged cells before saving the file.
 

Constructor Detail

GridHtmlSaveOptions

public GridHtmlSaveOptions()
Creates options for saving html file.

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.

getExportSingleTab/setExportSingleTab

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

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.

getExportPrintAreaOnly/setExportPrintAreaOnly

public boolean getExportPrintAreaOnly() / public void setExportPrintAreaOnly(boolean value)
Indicates if only exporting the print area to html file. The default value is false.

getExportArea/setExportArea

public GridCellArea getExportArea() / public void setExportArea(GridCellArea 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 omited. Only the specified area will be exported when saving the file to html.

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

getEncoding

public com.aspose.cells.Encoding getEncoding()
If not set,use Encoding.UTF8 as default enconding type.

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.

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.

getExportHeadings/setExportHeadings

public boolean getExportHeadings() / public void setExportHeadings(boolean 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.

getExportGridLines/setExportGridLines

public boolean getExportGridLines() / public void setExportGridLines(boolean value)
Indicating whether exporting the gridlines.The default value is false.

getSaveFormat

→ inherited from GridSaveOptions
public com.aspose.gridweb.GridSaveFormat getSaveFormat()
Gets the save file format.

getClearData/setClearData

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

getCachedFileFolder/setCachedFileFolder

→ inherited from GridSaveOptions
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 GridSaveOptions
public boolean getValidateMergedAreas() / public void setValidateMergedAreas(boolean value)
Indicates whether validate merged cells before saving the file. The default value is false.

getMergeAreas/setMergeAreas

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

→ inherited from GridSaveOptions
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 GridSaveOptions
public boolean getSortNames() / public void setSortNames(boolean value)
Indicates whether sorting defined names before saving file.

getRefreshChartCache/setRefreshChartCache

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

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