GridHtmlSaveOptions
Inheritance: java.lang.Object, com.aspose.gridweb.GridSaveOptions
public class GridHtmlSaveOptions extends GridSaveOptions
Represents the options for saving html file.
Constructors
| Constructor | Description |
|---|---|
| GridHtmlSaveOptions() | Creates options for saving html file. |
| GridHtmlSaveOptions(int format) | Creates options for saving htm file. |
Methods
| Method | Description |
|---|---|
| equals(Object arg0) | |
| getAttachedFilesDirectory() | The directory that the attached files will be saved to. |
| getAttachedFilesUrlPrefix() | Specify the Url prefix of attached files such as image in the html file. |
| getCachedFileFolder() | The cached file folder is used to store some large data. |
| getClass() | |
| getClearData() | Make the workbook empty after saving the file. |
| getCreateDirectory() | If true and the directory does not exist, the directory will be automatically created before saving the file. |
| getDefaultFontName() | 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. |
| getEncoding() | If not set,use Encoding.UTF8 as default enconding type. |
| getExportActiveWorksheetOnly() | Indicates if exporting the whole workbook to html file. |
| getExportArea() | Gets the exporting CellArea of current active Worksheet. |
| getExportGridLines() | Indicating whether exporting the gridlines.The default value is false. |
| getExportHeadings() | Indicates whether exporting headings when saving file to html.The default value is false. |
| getExportHiddenWorksheet() | Indicating if exporting the hidden worksheet content.The default value is true. |
| getExportImagesAsBase64() | Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB. |
| getExportPrintAreaOnly() | Indicates if only exporting the print area to html file. |
| getExportSingleTab() | Indicates whether exporting the single tab when the file only has one worksheet. |
| getMergeAreas() | Indicates whether merge the areas of conditional formatting and validation before saving the file. |
| getPageTitle() | The title of the html page. |
| getParseHtmlTagInCell() | Parse html tag in cell,like |
,as cell value,or as html tag,default is true | | getPresentationPreference() | 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. | | getRefreshChartCache() | Indicates whether refreshing chart cache data | | getSaveFormat() | Gets the save file format. | | getSortNames() | Indicates whether sorting defined names before saving file. | | getValidateMergedAreas() | Indicates whether validate merged cells before saving the file. | | hashCode() | | | isExportComments() | Indicates if exporting comments when saving file to html, the default value is false. | | isFullPathLink() | Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. | | notify() | | | notifyAll() | | | setAttachedFilesDirectory(String value) | The directory that the attached files will be saved to. | | setAttachedFilesUrlPrefix(String value) | Specify the Url prefix of attached files such as image in the html file. | | setCachedFileFolder(String value) | The cached file folder is used to store some large data. | | setClearData(boolean value) | Make the workbook empty after saving the file. | | setCreateDirectory(boolean value) | If true and the directory does not exist, the directory will be automatically created before saving the file. | | setDefaultFontName(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. | | setEncoding(Encoding value) | If not set,use Encoding.UTF8 as default enconding type. | | setExportActiveWorksheetOnly(boolean value) | Indicates if exporting the whole workbook to html file. | | setExportArea(GridCellArea value) | Sets the exporting CellArea of current active Worksheet. | | setExportComments(boolean value) | Indicates if exporting comments when saving file to html, the default value is false. | | setExportGridLines(boolean value) | Indicating whether exporting the gridlines.The default value is false. | | setExportHeadings(boolean value) | Indicates whether exporting headings when saving file to html.The default value is false. | | setExportHiddenWorksheet(boolean value) | Indicating if exporting the hidden worksheet content.The default value is true. | | setExportImagesAsBase64(boolean value) | Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB. | | setExportPrintAreaOnly(boolean value) | Indicates if only exporting the print area to html file. | | setExportSingleTab(boolean value) | Indicates whether exporting the single tab when the file only has one worksheet. | | setFullPathLink(boolean value) | Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. | | setMergeAreas(boolean value) | Indicates whether merge the areas of conditional formatting and validation before saving the file. | | setPageTitle(String value) | The title of the html page. | | setParseHtmlTagInCell(boolean value) | Parse html tag in cell,like
,as cell value,or as html tag,default is true | | 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. | | setRefreshChartCache(boolean value) | Indicates whether refreshing chart cache data | | setSortNames(boolean value) | Indicates whether sorting defined names before saving file. | | setValidateMergedAreas(boolean value) | Indicates whether validate merged cells before saving the file. | | toString() | | | wait() | | | wait(long arg0) | | | wait(long arg0, int arg1) | |
GridHtmlSaveOptions()
public GridHtmlSaveOptions()
Creates options for saving html file.
GridHtmlSaveOptions(int format)
public GridHtmlSaveOptions(int format)
Creates options for saving htm file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| format | int | GridSaveFormat. The saving file format. |
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getAttachedFilesDirectory()
public String getAttachedFilesDirectory()
The directory that the attached files will be saved to. Only for saving to html stream.
Returns: java.lang.String
getAttachedFilesUrlPrefix()
public String getAttachedFilesUrlPrefix()
Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.
Returns: java.lang.String
getCachedFileFolder()
public String getCachedFileFolder()
The cached file folder is used to store some large data.
Returns: java.lang.String
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getClearData()
public boolean getClearData()
Make the workbook empty after saving the file.
Returns: boolean
getCreateDirectory()
public boolean getCreateDirectory()
If true and the directory does not exist, the directory will be automatically created before saving the file.
Remarks
The default value is false.
Returns: boolean
getDefaultFontName()
public String getDefaultFontName()
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.
Returns: java.lang.String
getEncoding()
public Encoding getEncoding()
If not set,use Encoding.UTF8 as default enconding type.
Returns: Encoding
getExportActiveWorksheetOnly()
public boolean getExportActiveWorksheetOnly()
Indicates if exporting the whole workbook to html file.
Returns: boolean
getExportArea()
public GridCellArea getExportArea()
Gets 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.
Returns: GridCellArea
getExportGridLines()
public boolean getExportGridLines()
Indicating whether exporting the gridlines.The default value is false.
Returns: boolean
getExportHeadings()
public boolean getExportHeadings()
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.
Returns: boolean
getExportHiddenWorksheet()
public boolean getExportHiddenWorksheet()
Indicating if exporting the hidden worksheet content.The default value is true.
Returns: boolean
getExportImagesAsBase64()
public boolean getExportImagesAsBase64()
Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
Remarks
When this property is set to true image data is exported directly on the img elements and separate files are not created.
Returns: boolean
getExportPrintAreaOnly()
public boolean getExportPrintAreaOnly()
Indicates if only exporting the print area to html file. The default value is false.
Returns: boolean
getExportSingleTab()
public boolean getExportSingleTab()
Indicates whether exporting the single tab when the file only has one worksheet. The default value is false.
Returns: boolean
getMergeAreas()
public boolean getMergeAreas()
Indicates whether merge the areas of conditional formatting and validation before saving the file.
Remarks
The default value is false.
Returns: boolean
getPageTitle()
public String getPageTitle()
The title of the html page. Only for saving to html stream.
Returns: java.lang.String
getParseHtmlTagInCell()
public boolean getParseHtmlTagInCell()
Parse html tag in cell,like
,as cell value,or as html tag,default is true
Returns: boolean
getPresentationPreference()
public boolean getPresentationPreference()
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.
Returns: boolean
getRefreshChartCache()
public boolean getRefreshChartCache()
Indicates whether refreshing chart cache data
Returns: boolean
getSaveFormat()
public int getSaveFormat()
Gets the save file format.
See GridSaveFormat.
Returns: int
getSortNames()
public boolean getSortNames()
Indicates whether sorting defined names before saving file.
Returns: boolean
getValidateMergedAreas()
public boolean getValidateMergedAreas()
Indicates whether validate merged cells before saving the file.
Remarks
The default value is false.
Returns: boolean
hashCode()
public native int hashCode()
Returns: int
isExportComments()
public boolean isExportComments()
Indicates if exporting comments when saving file to html, the default value is false.
Returns: boolean
isFullPathLink()
public boolean isFullPathLink()
Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false.
Returns: boolean
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setAttachedFilesDirectory(String value)
public void setAttachedFilesDirectory(String value)
The directory that the attached files will be saved to. Only for saving to html stream.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setAttachedFilesUrlPrefix(String value)
public void setAttachedFilesUrlPrefix(String value)
Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setCachedFileFolder(String value)
public void setCachedFileFolder(String value)
The cached file folder is used to store some large data.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setClearData(boolean value)
public void setClearData(boolean value)
Make the workbook empty after saving the file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setCreateDirectory(boolean value)
public void setCreateDirectory(boolean value)
If true and the directory does not exist, the directory will be automatically created before saving the file.
Remarks
The default value is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setDefaultFontName(String value)
public void setDefaultFontName(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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setEncoding(Encoding value)
public void setEncoding(Encoding value)
If not set,use Encoding.UTF8 as default enconding type.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Encoding |
setExportActiveWorksheetOnly(boolean value)
public void setExportActiveWorksheetOnly(boolean value)
Indicates if exporting the whole workbook to html file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setExportArea(GridCellArea value)
public void setExportArea(GridCellArea value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | GridCellArea |
setExportComments(boolean value)
public void setExportComments(boolean value)
Indicates if exporting comments when saving file to html, the default value is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setExportGridLines(boolean value)
public void setExportGridLines(boolean value)
Indicating whether exporting the gridlines.The default value is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setExportHeadings(boolean value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setExportHiddenWorksheet(boolean value)
public void setExportHiddenWorksheet(boolean value)
Indicating if exporting the hidden worksheet content.The default value is true.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setExportImagesAsBase64(boolean value)
public void setExportImagesAsBase64(boolean value)
Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
Remarks
When this property is set to true image data is exported directly on the img elements and separate files are not created.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setExportPrintAreaOnly(boolean value)
public void setExportPrintAreaOnly(boolean value)
Indicates if only exporting the print area to html file. The default value is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setExportSingleTab(boolean value)
public void setExportSingleTab(boolean value)
Indicates whether exporting the single tab when the file only has one worksheet. The default value is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setFullPathLink(boolean value)
public void setFullPathLink(boolean value)
Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setMergeAreas(boolean value)
public void setMergeAreas(boolean value)
Indicates whether merge the areas of conditional formatting and validation before saving the file.
Remarks
The default value is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setPageTitle(String value)
public void setPageTitle(String value)
The title of the html page. Only for saving to html stream.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setParseHtmlTagInCell(boolean value)
public void setParseHtmlTagInCell(boolean value)
Parse html tag in cell,like
,as cell value,or as html tag,default is true
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setPresentationPreference(boolean value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setRefreshChartCache(boolean value)
public void setRefreshChartCache(boolean value)
Indicates whether refreshing chart cache data
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setSortNames(boolean value)
public void setSortNames(boolean value)
Indicates whether sorting defined names before saving file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setValidateMergedAreas(boolean value)
public void setValidateMergedAreas(boolean value)
Indicates whether validate merged cells before saving the file.
Remarks
The default value is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |