Package com.groupdocs.cloud.conversion.model

Class SpreadsheetLoadOptions

java.lang.Object

com.groupdocs.cloud.conversion.model.LoadOptions

com.groupdocs.cloud.conversion.model.SpreadsheetLoadOptions

Direct Known Subclasses:

CsvLoadOptions, OdsLoadOptions, OtsLoadOptions, TsvLoadOptions, Xls2003LoadOptions, XlsbLoadOptions, XlsLoadOptions, XlsmLoadOptions, XlsxLoadOptions, XltmLoadOptions, XltxLoadOptions

public class SpreadsheetLoadOptions
extends LoadOptions

Spreadsheet document load options

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpreadsheetLoadOptions.PrintCommentsEnum	Represents the way comments are printed with the sheet.

Constructor Summary

Constructors

Constructor	Description
SpreadsheetLoadOptions()

Method Summary

Modifier and Type	Method	Description
SpreadsheetLoadOptions	convertRange(String convertRange)
SpreadsheetLoadOptions	defaultFont(String defaultFont)
boolean	equals(Object o)
SpreadsheetLoadOptions	fontSubstitutes(Map<String,String> fontSubstitutes)
String	getConvertRange()	Convert specific range when converting to other than cells format.
String	getDefaultFont()	Default font for Cells document.
Map<String,String>	getFontSubstitutes()	Substitute specific fonts when converting Cells document.
Boolean	getOnePagePerSheet()	If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document.
String	getPassword()	Set password to unprotect protected document
SpreadsheetLoadOptions.PrintCommentsEnum	getPrintComments()	Represents the way comments are printed with the sheet.
Boolean	getShowGridLines()	Show grid lines when converting Excel files
Boolean	getShowHiddenSheets()	Show hidden sheets when converting Excel files
Boolean	getSkipEmptyRowsAndColumns()	Skips empty rows and columns when converting.
int	hashCode()
SpreadsheetLoadOptions	onePagePerSheet(Boolean onePagePerSheet)
SpreadsheetLoadOptions	password(String password)
SpreadsheetLoadOptions	printComments(SpreadsheetLoadOptions.PrintCommentsEnum printComments)
SpreadsheetLoadOptions	putFontSubstitutesItem(String key, String fontSubstitutesItem)
void	setConvertRange(String convertRange)
void	setDefaultFont(String defaultFont)
void	setFontSubstitutes(Map<String,String> fontSubstitutes)
void	setOnePagePerSheet(Boolean onePagePerSheet)
void	setPassword(String password)
void	setPrintComments(SpreadsheetLoadOptions.PrintCommentsEnum printComments)
void	setShowGridLines(Boolean showGridLines)
void	setShowHiddenSheets(Boolean showHiddenSheets)
void	setSkipEmptyRowsAndColumns(Boolean skipEmptyRowsAndColumns)
SpreadsheetLoadOptions	showGridLines(Boolean showGridLines)
SpreadsheetLoadOptions	showHiddenSheets(Boolean showHiddenSheets)
SpreadsheetLoadOptions	skipEmptyRowsAndColumns(Boolean skipEmptyRowsAndColumns)
String	toString()

Methods inherited from class com.groupdocs.cloud.conversion.model.LoadOptions

format, getFormat, setFormat

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SpreadsheetLoadOptions

public SpreadsheetLoadOptions()

Method Detail

defaultFont

public SpreadsheetLoadOptions defaultFont(String defaultFont)

getDefaultFont

public String getDefaultFont()

Default font for Cells document. The following font will be used if a font is missing.

Returns:

defaultFont

setDefaultFont

public void setDefaultFont(String defaultFont)

fontSubstitutes

public SpreadsheetLoadOptions fontSubstitutes(Map<String,String> fontSubstitutes)

putFontSubstitutesItem

public SpreadsheetLoadOptions putFontSubstitutesItem(String key,
                                                     String fontSubstitutesItem)

getFontSubstitutes

public Map<String,String> getFontSubstitutes()

Substitute specific fonts when converting Cells document.

Returns:

fontSubstitutes

setFontSubstitutes

public void setFontSubstitutes(Map<String,String> fontSubstitutes)

showGridLines

public SpreadsheetLoadOptions showGridLines(Boolean showGridLines)

getShowGridLines

public Boolean getShowGridLines()

Show grid lines when converting Excel files

Returns:

showGridLines

setShowGridLines

public void setShowGridLines(Boolean showGridLines)

showHiddenSheets

public SpreadsheetLoadOptions showHiddenSheets(Boolean showHiddenSheets)

getShowHiddenSheets

public Boolean getShowHiddenSheets()

Show hidden sheets when converting Excel files

Returns:

showHiddenSheets

setShowHiddenSheets

public void setShowHiddenSheets(Boolean showHiddenSheets)

onePagePerSheet

public SpreadsheetLoadOptions onePagePerSheet(Boolean onePagePerSheet)

getOnePagePerSheet

public Boolean getOnePagePerSheet()

If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document. Default value is true.

Returns:

onePagePerSheet

setOnePagePerSheet

public void setOnePagePerSheet(Boolean onePagePerSheet)

convertRange

public SpreadsheetLoadOptions convertRange(String convertRange)

getConvertRange

public String getConvertRange()

Convert specific range when converting to other than cells format. Example: \"D1:F8\"

Returns:

convertRange

setConvertRange

public void setConvertRange(String convertRange)

skipEmptyRowsAndColumns

public SpreadsheetLoadOptions skipEmptyRowsAndColumns(Boolean skipEmptyRowsAndColumns)

getSkipEmptyRowsAndColumns

public Boolean getSkipEmptyRowsAndColumns()

Skips empty rows and columns when converting. Default is True.

Returns:

skipEmptyRowsAndColumns

setSkipEmptyRowsAndColumns

public void setSkipEmptyRowsAndColumns(Boolean skipEmptyRowsAndColumns)

password

public SpreadsheetLoadOptions password(String password)

getPassword

public String getPassword()

Set password to unprotect protected document

Returns:

password

setPassword

public void setPassword(String password)

printComments

public SpreadsheetLoadOptions printComments(SpreadsheetLoadOptions.PrintCommentsEnum printComments)

getPrintComments

public SpreadsheetLoadOptions.PrintCommentsEnum getPrintComments()

Represents the way comments are printed with the sheet. Default is PrintNoComments.

Returns:

printComments

setPrintComments

public void setPrintComments(SpreadsheetLoadOptions.PrintCommentsEnum printComments)

equals

public boolean equals(Object o)

Overrides:

equals in class LoadOptions

hashCode

public int hashCode()

Overrides:

hashCode in class LoadOptions

toString

public String toString()

Overrides:

toString in class LoadOptions