GridHtmlSaveOptions (Aspose.Cells for Java)

java.lang.Object
- com.aspose.gridweb.GridSaveOptions
- - com.aspose.gridweb.GridHtmlSaveOptions

public class GridHtmlSaveOptions
extends GridSaveOptions

Represents the options for saving html file.

Constructor Summary

Constructors
Constructor and Description

GridHtmlSaveOptions()
Creates options for saving html file.

GridHtmlSaveOptions(int format)
Creates options for saving htm file.

Constructors
Constructor and Description
`GridHtmlSaveOptions()` Creates options for saving html file.
`GridHtmlSaveOptions(int format)` Creates options for saving htm file.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttachedFilesDirectory()` The directory that the attached files will be saved to.
`java.lang.String`	`getAttachedFilesUrlPrefix()` Specify the Url prefix of attached files such as image in the html file.
`java.lang.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.
`Encoding`	`getEncoding()` If not set,use Encoding.UTF8 as default enconding type.
`boolean`	`getExportActiveWorksheetOnly()` Indicates if exporting the whole workbook to html file.
`GridCellArea`	`getExportArea()` Gets the exporting CellArea of current active Worksheet.
`boolean`	`getExportGridLines()` Indicating whether exporting the gridlines.The default value is false.
`boolean`	`getExportHeadings()` Indicates whether exporting headings when saving file to html.The default value is false.
`boolean`	`getExportHiddenWorksheet()` Indicating if exporting the hidden worksheet content.The default value is true.
`boolean`	`getExportImagesAsBase64()` Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
`boolean`	`getExportPrintAreaOnly()` Indicates if only exporting the print area to html file.
`boolean`	`getExportSingleTab()` Indicates whether exporting the single tab when the file only has one worksheet.
`java.lang.String`	`getPageTitle()` The title of the html page.
`boolean`	`getParseHtmlTagInCell()` Parse html tag in cell,like ,as cell value,or as html tag,default is true
`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.
`boolean`	`isExportComments()` Indicates if exporting comments when saving file to html, the default value is false.
`boolean`	`isFullPathLink()` Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm.
`void`	`setAttachedFilesDirectory(java.lang.String value)` The directory that the attached files will be saved to.
`void`	`setAttachedFilesUrlPrefix(java.lang.String value)` Specify the Url prefix of attached files such as image in the html file.
`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.
`void`	`setEncoding(Encoding value)` If not set,use Encoding.UTF8 as default enconding type.
`void`	`setExportActiveWorksheetOnly(boolean value)` Indicates if exporting the whole workbook to html file.
`void`	`setExportArea(GridCellArea value)` Sets the exporting CellArea of current active Worksheet.
`void`	`setExportComments(boolean value)` Indicates if exporting comments when saving file to html, the default value is false.
`void`	`setExportGridLines(boolean value)` Indicating whether exporting the gridlines.The default value is false.
`void`	`setExportHeadings(boolean value)` Indicates whether exporting headings when saving file to html.The default value is false.
`void`	`setExportHiddenWorksheet(boolean value)` Indicating if exporting the hidden worksheet content.The default value is true.
`void`	`setExportImagesAsBase64(boolean value)` Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
`void`	`setExportPrintAreaOnly(boolean value)` Indicates if only exporting the print area to html file.
`void`	`setExportSingleTab(boolean value)` Indicates whether exporting the single tab when the file only has one worksheet.
`void`	`setFullPathLink(boolean value)` Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm.
`void`	`setPageTitle(java.lang.String value)` The title of the html page.
`void`	`setParseHtmlTagInCell(boolean value)` Parse html tag in cell,like ,as cell value,or as html tag,default is true
`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.

Methods inherited from class com.aspose.gridweb.GridSaveOptions
getCachedFileFolder, getClearData, getCreateDirectory, getMergeAreas, getRefreshChartCache, getSaveFormat, getSortNames, getValidateMergedAreas, setCachedFileFolder, setClearData, setCreateDirectory, setMergeAreas, setRefreshChartCache, setSortNames, setValidateMergedAreas

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GridHtmlSaveOptions
```
public GridHtmlSaveOptions()
```
    Creates options for saving html file.
  - GridHtmlSaveOptions
```
public GridHtmlSaveOptions(int format)
```
    Creates options for saving htm file.
    
    Parameters:
    format - GridSaveFormat. The saving file format.
- Method Detail
  - getPageTitle
```
public java.lang.String getPageTitle()
```
    The title of the html page. Only for saving to html stream.
  - setPageTitle
```
public void setPageTitle(java.lang.String value)
```
    The title of the html page. Only for saving to html stream.
  - getAttachedFilesDirectory
```
public java.lang.String getAttachedFilesDirectory()
```
    The directory that the attached files will be saved to. Only for saving to html stream.
  - setAttachedFilesDirectory
```
public void setAttachedFilesDirectory(java.lang.String value)
```
    The directory that the attached files will be saved to. Only for saving to html stream.
  - getAttachedFilesUrlPrefix
```
public java.lang.String getAttachedFilesUrlPrefix()
```
    Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.
  - setAttachedFilesUrlPrefix
```
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
```
public java.lang.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.
  - setDefaultFontName
```
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
```
public boolean isExportComments()
```
    Indicates if exporting comments when saving file to html, the default value is false.
  - setExportComments
```
public void setExportComments(boolean value)
```
    Indicates if exporting comments when saving file to html, the default value is false.
  - getExportSingleTab
```
public boolean getExportSingleTab()
```
    Indicates whether exporting the single tab when the file only has one worksheet. The default value is false.
  - setExportSingleTab
```
public void setExportSingleTab(boolean value)
```
    Indicates whether exporting the single tab when the file only has one worksheet. The default value is false.
  - 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.
  - setExportImagesAsBase64
```
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.
  - getExportActiveWorksheetOnly
```
public boolean getExportActiveWorksheetOnly()
```
    Indicates if exporting the whole workbook to html file.
  - setExportActiveWorksheetOnly
```
public void setExportActiveWorksheetOnly(boolean value)
```
    Indicates if exporting the whole workbook to html file.
  - getExportPrintAreaOnly
```
public boolean getExportPrintAreaOnly()
```
    Indicates if only exporting the print area to html file. The default value is false.
  - setExportPrintAreaOnly
```
public void setExportPrintAreaOnly(boolean value)
```
    Indicates if only exporting the print area to html file. The default value is false.
  - 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.
  - setExportArea
```
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.
  - getParseHtmlTagInCell
```
public boolean getParseHtmlTagInCell()
```
    Parse html tag in cell,like
    ,as cell value,or as html tag,default is true
  - setParseHtmlTagInCell
```
public void setParseHtmlTagInCell(boolean value)
```
    Parse html tag in cell,like
    ,as cell value,or as html tag,default is true
  - getEncoding
```
public Encoding getEncoding()
```
    If not set,use Encoding.UTF8 as default enconding type.
  - setEncoding
```
public void setEncoding(Encoding value)
```
    If not set,use Encoding.UTF8 as default enconding type.
  - getExportHiddenWorksheet
```
public boolean getExportHiddenWorksheet()
```
    Indicating if exporting the hidden worksheet content.The default value is true.
  - setExportHiddenWorksheet
```
public void setExportHiddenWorksheet(boolean value)
```
    Indicating if exporting the hidden worksheet content.The default value is true.
  - 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.
  - setPresentationPreference
```
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
```
public boolean isFullPathLink()
```
    Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false.
  - setFullPathLink
```
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
```
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.
  - setExportHeadings
```
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
```
public boolean getExportGridLines()
```
    Indicating whether exporting the gridlines.The default value is false.
  - setExportGridLines
```
public void setExportGridLines(boolean value)
```
    Indicating whether exporting the gridlines.The default value is false.

Class GridHtmlSaveOptions

Constructor Summary

Method Summary

Methods inherited from class com.aspose.gridweb.GridSaveOptions

Methods inherited from class java.lang.Object

Constructor Detail

GridHtmlSaveOptions

GridHtmlSaveOptions

Method Detail

getPageTitle

setPageTitle

getAttachedFilesDirectory

setAttachedFilesDirectory

getAttachedFilesUrlPrefix

setAttachedFilesUrlPrefix

getDefaultFontName

setDefaultFontName

isExportComments

setExportComments

getExportSingleTab

setExportSingleTab

getExportImagesAsBase64

setExportImagesAsBase64

getExportActiveWorksheetOnly

setExportActiveWorksheetOnly

getExportPrintAreaOnly

setExportPrintAreaOnly

getExportArea

setExportArea

getParseHtmlTagInCell

setParseHtmlTagInCell

getEncoding

setEncoding

getExportHiddenWorksheet

setExportHiddenWorksheet

getPresentationPreference

setPresentationPreference

isFullPathLink

setFullPathLink

getExportHeadings

setExportHeadings

getExportGridLines

setExportGridLines