HtmlSaveOptions

java.lang.Object
- com.grapecity.documents.excel.SaveOptionsBase
- - com.grapecity.documents.excel.drawing.HtmlSaveOptions

public class HtmlSaveOptions
extends SaveOptionsBase

Option class for saving html file.

Constructor Summary

Constructors
Constructor and Description

HtmlSaveOptions()
Creates options for saving html file.

Constructors
Constructor and Description
`HtmlSaveOptions()` Creates options for saving html file.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getAddTooltipText()` Gets whether adding tooltip text when the data can't be fully displayed.
`java.lang.String`	`getAttachedFilesUrlPrefix()` Gets the Url prefix of attached files such as image in the html file.
`java.lang.String`	`getCellCssPrefix()` Gets the prefix of the css name, the default value is null.
`HtmlSaveOptionsData`	`getData()`
`java.lang.String`	`getEncoding()` Gets encoding.
`java.lang.String`	`getExportArea()` Gets which area would be exported to html.
`boolean`	`getExportCssSeparately()` Gets whether export the worksheet style to css separately.
`boolean`	`getExportDocumentProperties()` Gets whether exporting document properties.
`java.lang.String`	`getExportFileName()` Gets the name of the html file.
`boolean`	`getExportGridlines()` Gets whether exporting the gridlines.
`boolean`	`getExportHeadings()` Gets whether exporting headings when saving file to html.
`boolean`	`getExportHiddenWorksheet()` Gets whether exporting headings when saving file to html.
`boolean`	`getExportImageAsBase64()` Gets whether images are saved in Base64 format to html.
`java.lang.String`	`getExportSheetName()` Gets which worksheet would be exported to html.
`boolean`	`getExportSingleTab()` Gets whether exporting the single tab when the file only has one worksheet or ExportSheetName is set.
`boolean`	`getIsExportComments()` Gets if exporting comments when saving file to html.
`boolean`	`getIsFullPathLink()` Gets whether using full path link in html.
`boolean`	`getIsWidthScalable()` Gets whether using scalable unit to describe the column width when exporting file to html.
`HyperLinkTargetType`	`getLinkTargetType()` Gets the type of target attribute in link.
`java.lang.String`	`getPageTitle()` Gets the title of the html page.
`java.lang.String`	`getTableCssId()` Gets the prefix of the type css name such as tr, td and so on, they are contained in the table element which has the specific TableCssId attribute.
`void`	`setAddTooltipText(boolean value)` Sets whether adding tooltip text when the data can't be fully displayed.
`void`	`setAttachedFilesUrlPrefix(java.lang.String value)` Sets the Url prefix of attached files such as image in the html file.
`void`	`setCellCssPrefix(java.lang.String value)` Sets the prefix of the css name.
`void`	`setEncoding(java.lang.String value)` Sets encoding.
`void`	`setExportArea(java.lang.String value)` Sets which area would be exported to html.
`void`	`setExportCssSeparately(boolean value)` Sets whether export the worksheet style to css separately.
`void`	`setExportDocumentProperties(boolean value)` Sets whether exporting document properties.
`void`	`setExportFileName(java.lang.String value)` Sets the name of the html file.
`void`	`setExportGridlines(boolean value)` Sets whether exporting the gridlines.
`void`	`setExportHeadings(boolean value)` Sets whether exporting headings when saving file to html.
`void`	`setExportHiddenWorksheet(boolean value)` Sets whether exporting headings when saving file to html.
`void`	`setExportImageAsBase64(boolean value)` Sets whether images are saved in Base64 format to html.
`void`	`setExportSheetName(java.lang.String value)` Sets which worksheet would be exported to html.
`void`	`setExportSingleTab(boolean value)` Sets whether exporting the single tab when the file only has one worksheet or ExportSheetName is set.
`void`	`setIsExportComments(boolean value)` Sets if exporting comments when saving file to html.
`void`	`setIsFullPathLink(boolean value)` Sets whether using full path link in html.
`void`	`setIsWidthScalable(boolean value)` Sets whether using scalable unit to describe the column width when exporting file to html.
`void`	`setLinkTargetType(HyperLinkTargetType value)` Sets the type of target attribute in link.
`void`	`setPageTitle(java.lang.String value)` Sets the title of the html page.
`void`	`setTableCssId(java.lang.String value)` Sets the prefix of the type css name such as tr, td and so on, they are contained in the table element which has the specific TableCssId attribute.

Methods inherited from class com.grapecity.documents.excel.SaveOptionsBase
getFileFormat

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

- Constructor Detail
  - HtmlSaveOptions
```
public HtmlSaveOptions()
```
    Creates options for saving html file.
- Method Detail
  - getData
```
public final HtmlSaveOptionsData getData()
```
  - getAddTooltipText
```
public final boolean getAddTooltipText()
```
    Gets whether adding tooltip text when the data can't be fully displayed. The default value is false.
  - setAddTooltipText
```
public final void setAddTooltipText(boolean value)
```
    Sets whether adding tooltip text when the data can't be fully displayed.
  - getExportFileName
```
public final java.lang.String getExportFileName()
```
    Gets the name of the html file. Only for saving to zip stream, and the default value is "workbook".
  - setExportFileName
```
public final void setExportFileName(java.lang.String value)
```
    Sets the name of the html file. Only for saving to zip stream.
  - getAttachedFilesUrlPrefix
```
public final java.lang.String getAttachedFilesUrlPrefix()
```
    Gets the Url prefix of attached files such as image in the html file.
  - setAttachedFilesUrlPrefix
```
public final void setAttachedFilesUrlPrefix(java.lang.String value)
```
    Sets the Url prefix of attached files such as image in the html file.
  - getCellCssPrefix
```
public final java.lang.String getCellCssPrefix()
```
    Gets the prefix of the css name, the default value is null.
  - setCellCssPrefix
```
public final void setCellCssPrefix(java.lang.String value)
```
    Sets the prefix of the css name.
  - getEncoding
```
public final java.lang.String getEncoding()
```
    Gets encoding. If not set, use utf-8 as default value.
  - setEncoding
```
public final void setEncoding(java.lang.String value)
```
    Sets encoding. If not set, use utf-8 as default value.
  - getExportDocumentProperties
```
public final boolean getExportDocumentProperties()
```
    Gets whether exporting document properties. The default value is true.
  - setExportDocumentProperties
```
public final void setExportDocumentProperties(boolean value)
```
    Sets whether exporting document properties.
  - getExportGridlines
```
public final boolean getExportGridlines()
```
    Gets whether exporting the gridlines. The default value is false.
  - setExportGridlines
```
public final void setExportGridlines(boolean value)
```
    Sets whether exporting the gridlines.
  - getExportHeadings
```
public final boolean getExportHeadings()
```
    Gets whether exporting headings when saving file to html. The default value is false.
  - setExportHeadings
```
public final void setExportHeadings(boolean value)
```
    Sets whether exporting headings when saving file to html.
  - getExportHiddenWorksheet
```
public final boolean getExportHiddenWorksheet()
```
    Gets whether exporting headings when saving file to html. The default value is false.
  - setExportHiddenWorksheet
```
public final void setExportHiddenWorksheet(boolean value)
```
    Sets whether exporting headings when saving file to html.
  - getExportImageAsBase64
```
public final boolean getExportImageAsBase64()
```
    Gets whether images are saved in Base64 format to html. The default value is false.
  - setExportImageAsBase64
```
public final void setExportImageAsBase64(boolean value)
```
    Sets whether images are saved in Base64 format to html. When this property is set to true image data is exported directly on the img elements and separate files are not created.
  - getExportCssSeparately
```
public final boolean getExportCssSeparately()
```
    Gets whether export the worksheet style to css separately. The default value is true.
  - setExportCssSeparately
```
public final void setExportCssSeparately(boolean value)
```
    Sets whether export the worksheet style to css separately. When this property is set to false. Css style data is exported directly to each worksheet and separate stylesheet.css file are not created.
  - getExportSingleTab
```
public final boolean getExportSingleTab()
```
    Gets whether exporting the single tab when the file only has one worksheet or ExportSheetName is set. The default value is false.
  - setExportSingleTab
```
public final void setExportSingleTab(boolean value)
```
    Sets whether exporting the single tab when the file only has one worksheet or ExportSheetName is set.
  - getIsExportComments
```
public final boolean getIsExportComments()
```
    Gets if exporting comments when saving file to html. The default value is false.
  - setIsExportComments
```
public final void setIsExportComments(boolean value)
```
    Sets if exporting comments when saving file to html.
  - getIsFullPathLink
```
public final boolean getIsFullPathLink()
```
    Gets whether using full path link in html. Only for exporting to html file. The default value is false.
  - setIsFullPathLink
```
public final void setIsFullPathLink(boolean value)
```
    Sets whether using full path link in html. Only for exporting to html file.
  - getLinkTargetType
```
public final HyperLinkTargetType getLinkTargetType()
```
    Gets the type of target attribute in link. The default value is HyperLinkTargetType.Blank.
  - setLinkTargetType
```
public final void setLinkTargetType(HyperLinkTargetType value)
```
    Sets the type of target attribute in link.
  - getPageTitle
```
public final java.lang.String getPageTitle()
```
    Gets the title of the html page.
  - setPageTitle
```
public final void setPageTitle(java.lang.String value)
```
    Sets the title of the html page.
  - getTableCssId
```
public final java.lang.String getTableCssId()
```
    Gets the prefix of the type css name such as tr, td and so on, they are contained in the table element which has the specific TableCssId attribute. The default value is null.
  - setTableCssId
```
public final void setTableCssId(java.lang.String value)
```
    Sets the prefix of the type css name such as tr, td and so on, they are contained in the table element which has the specific TableCssId attribute.
  - getIsWidthScalable
```
public final boolean getIsWidthScalable()
```
    Gets whether using scalable unit to describe the column width when exporting file to html. The default value is false.
  - setIsWidthScalable
```
public final void setIsWidthScalable(boolean value)
```
    Sets whether using scalable unit to describe the column width when exporting file to html.
  - getExportSheetName
```
public final java.lang.String getExportSheetName()
```
    Gets which worksheet would be exported to html. This is used for exporting specific worksheet of workbook.
  - setExportSheetName
```
public final void setExportSheetName(java.lang.String value)
```
    Sets which worksheet would be exported to html. This is used for exporting specific worksheet of workbook.
  - getExportArea
```
public final java.lang.String getExportArea()
```
    Gets which area would be exported to html. This is used for exporting specific area of worksheet. Only take effect when HtmlSaveOptions.ExportSheetName is not null.
  - setExportArea
```
public final void setExportArea(java.lang.String value)
```
    Sets which area would be exported to html. This is used for exporting specific area of worksheet. Only take effect when HtmlSaveOptions.ExportSheetName is not null.

Class HtmlSaveOptions

Constructor Summary

Method Summary

Methods inherited from class com.grapecity.documents.excel.SaveOptionsBase

Methods inherited from class java.lang.Object

Constructor Detail

HtmlSaveOptions

Method Detail

getData

getAddTooltipText

setAddTooltipText

getExportFileName

setExportFileName

getAttachedFilesUrlPrefix

setAttachedFilesUrlPrefix

getCellCssPrefix

setCellCssPrefix

getEncoding

setEncoding

getExportDocumentProperties

setExportDocumentProperties

getExportGridlines

setExportGridlines

getExportHeadings

setExportHeadings

getExportHiddenWorksheet

setExportHiddenWorksheet

getExportImageAsBase64

setExportImageAsBase64

getExportCssSeparately

setExportCssSeparately

getExportSingleTab

setExportSingleTab

getIsExportComments

setIsExportComments

getIsFullPathLink

setIsFullPathLink

getLinkTargetType

setLinkTargetType

getPageTitle

setPageTitle

getTableCssId

setTableCssId

getIsWidthScalable

setIsWidthScalable

getExportSheetName

setExportSheetName

getExportArea

setExportArea