public class CellsToHtmlOptions extends Object implements IDocumentLoadOptions
Allows to specify custom options for loading documents of all supportable Cells (Excel-compatible) formats
Modifier and Type | Class and Description |
---|---|
static class |
CellsToHtmlOptions.TextLoadOptions
Subclass for loading text-based Cells documents (CSV, Tab-based etc.)
|
Constructor and Description |
---|
CellsToHtmlOptions() |
Modifier and Type | Method and Description |
---|---|
boolean |
getExcludeHiddenWorksheets()
Allows to exclude hidden worksheets in the input Cells document, so they will be totally ignored.
|
boolean |
getOptimizeMemoryUsage()
Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases,
but on the other hand decrease memory usage.
|
String |
getPassword()
Allows to specify, modify and obtain the password, which will be used for opening the Cells document, if it is encoded.
|
CellsToHtmlOptions.TextLoadOptions |
getTextOptions()
Allows to specify options for loading text-based Cells documents
|
int |
getWorksheetIndex()
Allows to specify the 0-based index of the worksheet (tab) of the input Cells document, which should be converted to the HTML (see remarks).
|
void |
setExcludeHiddenWorksheets(boolean value)
Allows to exclude hidden worksheets in the input Cells document, so they will be totally ignored.
|
void |
setOptimizeMemoryUsage(boolean value)
Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases,
but on the other hand decrease memory usage.
|
void |
setPassword(String value)
Allows to specify, modify and obtain the password, which will be used for opening the Cells document, if it is encoded.
|
void |
setTextOptions(CellsToHtmlOptions.TextLoadOptions value)
Allows to specify options for loading text-based Cells documents
|
void |
setWorksheetIndex(int value)
Allows to specify the 0-based index of the worksheet (tab) of the input Cells document, which should be converted to the HTML (see remarks).
|
public boolean getExcludeHiddenWorksheets()
Allows to exclude hidden worksheets in the input Cells document, so they will be totally ignored. Default is false - hidden worksheets are available and processed as normal.
WorksheetIndex
' property.
public boolean getOptimizeMemoryUsage()
Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage. Useful when processing huge documents and facing OutOfMemoryException. Default is false (memory optimization is disabled for the sake of better performance).
public String getPassword()
Allows to specify, modify and obtain the password, which will be used for opening the Cells document, if it is encoded. Set to NULL or empty string in order to remove the password. Useless for text-based Cells documents like CSV.
public CellsToHtmlOptions.TextLoadOptions getTextOptions()
Allows to specify options for loading text-based Cells documents
public int getWorksheetIndex()
Allows to specify the 0-based index of the worksheet (tab) of the input Cells document, which should be converted to the HTML (see remarks).
public void setExcludeHiddenWorksheets(boolean value)
Allows to exclude hidden worksheets in the input Cells document, so they will be totally ignored. Default is false - hidden worksheets are available and processed as normal.
WorksheetIndex
' property.
public void setOptimizeMemoryUsage(boolean value)
Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage. Useful when processing huge documents and facing OutOfMemoryException. Default is false (memory optimization is disabled for the sake of better performance).
public void setPassword(String value)
Allows to specify, modify and obtain the password, which will be used for opening the Cells document, if it is encoded. Set to NULL or empty string in order to remove the password. Useless for text-based Cells documents like CSV.
public void setTextOptions(CellsToHtmlOptions.TextLoadOptions value)
Allows to specify options for loading text-based Cells documents
public void setWorksheetIndex(int value)
Allows to specify the 0-based index of the worksheet (tab) of the input Cells document, which should be converted to the HTML (see remarks).
Copyright © 2018. All rights reserved.