com.groupdocs.editor.options

Class SpreadsheetEditOptions

java.lang.Object

com.groupdocs.editor.options.SpreadsheetEditOptions

All Implemented Interfaces:

IEditOptions

public class SpreadsheetEditOptions
extends Object
implements IEditOptions

Allows to specify custom options for editing documents of all supportable Spreadsheet (Excel-compatible) formats

Constructor Summary

Constructors

Constructor and Description
SpreadsheetEditOptions()

Method Summary

Modifier and Type	Method and Description
boolean	getExcludeHiddenWorksheets() Allows to exclude hidden worksheets in the input Spreadsheet document, so they will be totally ignored.
boolean	getExportBogusRowData() When enabled, the HTML table in produced HTML document contains an empty bottom hidden row with zero height and empty cells, where only width is specified.
boolean	getMergeEmptyAdjacentCells() When enabled, the empty adjacent horizontal cells from the input Spreadsheet document will be represented in editable HTML document as merged into a single cell with corresponding colspan attribute.
int	getWorksheetIndex() Allows to specify the 0-based index of the worksheet (tab) of the input Spreadsheet document, which should be converted to the HTML (see remarks).
void	setExcludeHiddenWorksheets(boolean value) Allows to exclude hidden worksheets in the input Spreadsheet document, so they will be totally ignored.
void	setExportBogusRowData(boolean value)
void	setMergeEmptyAdjacentCells(boolean value)
void	setWorksheetIndex(int value) Allows to specify the 0-based index of the worksheet (tab) of the input Spreadsheet document, which should be converted to the HTML (see remarks).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpreadsheetEditOptions

public SpreadsheetEditOptions()

Method Detail

getExcludeHiddenWorksheets

public final boolean getExcludeHiddenWorksheets()

Allows to exclude hidden worksheets in the input Spreadsheet document, so they will be totally ignored. Default is false - hidden worksheets are available and processed as normal.

Several binary Spreadsheet formats (like XLSX) support hidden worksheets (tabs) concept. Document of such format, if it has more then one worksheet, may contain additional hidden worksheets. By default such hidden worksheets are available for processing, but with this option it is able to ignore them, like these hidden worksheets are absent and don't exist. When this option is enabled, you cannot select hidden worksheet with the 'WorksheetIndex(getWorksheetIndex()/setWorksheetIndex(int))' property.

getExportBogusRowData

public boolean getExportBogusRowData()

When enabled, the HTML table in produced HTML document contains an empty bottom hidden row with zero height and empty cells, where only width is specified. This row with empty cells contains exact width values for each column and improves backward conversion from HTML to Spreadsheet. By default is enabled (true).

getMergeEmptyAdjacentCells

public boolean getMergeEmptyAdjacentCells()

When enabled, the empty adjacent horizontal cells from the input Spreadsheet document will be represented in editable HTML document as merged into a single cell with corresponding colspan attribute. By default is disabled (false).

By default the GroupDocs.Editor converts a table from input Spreadsheet document to the output HTML document by preserving each cell. However, the Spreadsheet documents may be sparse — they may contain huge amount of "empty areas", where a lot of cells are empty. This option, when enabled, merges such empty cells into one with colspan attribute in the TD element, and thus can significantly reduce the size of the produced HTML markup.

getWorksheetIndex

public final int getWorksheetIndex()

Allows to specify the 0-based index of the worksheet (tab) of the input Spreadsheet document, which should be converted to the HTML (see remarks).

Most of Spreadsheet documents support a concept of tabs, i.e. they can be multi-tabbed. On the other hand, HTML format doesn't support such structure. Because of this GroupDocs.Editor can convert to the HTML only one specific tab of the input document, and this option allows to specify it. Tab index is 0-based, negative values are prohibited. If specified index exceeds the number of all tabs, the exception will be thrown. If input Spreadsheet document contains only one tab, this option will be ignored. Default value is 0 (first tab).

setExcludeHiddenWorksheets

public final void setExcludeHiddenWorksheets(boolean value)

Allows to exclude hidden worksheets in the input Spreadsheet document, so they will be totally ignored. Default is false - hidden worksheets are available and processed as normal.

Several binary Spreadsheet formats (like XLSX) support hidden worksheets (tabs) concept. Document of such format, if it has more then one worksheet, may contain additional hidden worksheets. By default such hidden worksheets are available for processing, but with this option it is able to ignore them, like these hidden worksheets are absent and don't exist. When this option is enabled, you cannot select hidden worksheet with the 'WorksheetIndex(getWorksheetIndex()/setWorksheetIndex(int))' property.

setExportBogusRowData

public void setExportBogusRowData(boolean value)

setMergeEmptyAdjacentCells

public void setMergeEmptyAdjacentCells(boolean value)

setWorksheetIndex

public final void setWorksheetIndex(int value)

Allows to specify the 0-based index of the worksheet (tab) of the input Spreadsheet document, which should be converted to the HTML (see remarks).

Most of Spreadsheet documents support a concept of tabs, i.e. they can be multi-tabbed. On the other hand, HTML format doesn't support such structure. Because of this GroupDocs.Editor can convert to the HTML only one specific tab of the input document, and this option allows to specify it. Tab index is 0-based, negative values are prohibited. If specified index exceeds the number of all tabs, the exception will be thrown. If input Spreadsheet document contains only one tab, this option will be ignored. Default value is 0 (first tab).