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	addSheetIndexesItem(Integer sheetIndexesItem)
SpreadsheetLoadOptions	addSheetsItem(String sheetsItem)
SpreadsheetLoadOptions	allColumnsInOnePagePerSheet(Boolean allColumnsInOnePagePerSheet)
SpreadsheetLoadOptions	autoFitRows(Boolean autoFitRows)
SpreadsheetLoadOptions	checkExcelRestriction(Boolean checkExcelRestriction)
SpreadsheetLoadOptions	clearBuiltInDocumentProperties(Boolean clearBuiltInDocumentProperties)
SpreadsheetLoadOptions	clearCustomDocumentProperties(Boolean clearCustomDocumentProperties)
SpreadsheetLoadOptions	columnsPerPage(Integer columnsPerPage)
SpreadsheetLoadOptions	convertRange(String convertRange)
SpreadsheetLoadOptions	cultureInfo(String cultureInfo)
SpreadsheetLoadOptions	defaultFont(String defaultFont)
boolean	equals(Object o)
SpreadsheetLoadOptions	fontSubstitutes(Map<String,String> fontSubstitutes)
Boolean	getAllColumnsInOnePagePerSheet()	If AllColumnsInOnePagePerSheet is true, all column content of one sheet will output to only one page in result.
Boolean	getAutoFitRows()	Autofits all rows when converting
Boolean	getCheckExcelRestriction()	Whether check restriction of excel file when user modify cells related objects.
Boolean	getClearBuiltInDocumentProperties()	Clear built-in document properties.
Boolean	getClearCustomDocumentProperties()	Clear custom document properties.
Integer	getColumnsPerPage()	Split a worksheet into pages by columns.
String	getConvertRange()	Convert specific range when converting to other than cells format.
String	getCultureInfo()	System culture info at the time file is loaded
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.
Boolean	getOptimizePdfSize()	If True and converting to Pdf the conversion is optimized for better file size than print quality.
String	getPassword()	Set password to unprotect protected document
SpreadsheetLoadOptions.PrintCommentsEnum	getPrintComments()	Represents the way comments are printed with the sheet.
Boolean	getResetFontFolders()	Reset font folders before loading document
Integer	getRowsPerPage()	Split a worksheet into pages by rows.
List<Integer>	getSheetIndexes()	List of sheet indexes to convert.
List<String>	getSheets()	List of sheet names to convert
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	optimizePdfSize(Boolean optimizePdfSize)
SpreadsheetLoadOptions	password(String password)
SpreadsheetLoadOptions	printComments(SpreadsheetLoadOptions.PrintCommentsEnum printComments)
SpreadsheetLoadOptions	putFontSubstitutesItem(String key, String fontSubstitutesItem)
SpreadsheetLoadOptions	resetFontFolders(Boolean resetFontFolders)
SpreadsheetLoadOptions	rowsPerPage(Integer rowsPerPage)
void	setAllColumnsInOnePagePerSheet(Boolean allColumnsInOnePagePerSheet)
void	setAutoFitRows(Boolean autoFitRows)
void	setCheckExcelRestriction(Boolean checkExcelRestriction)
void	setClearBuiltInDocumentProperties(Boolean clearBuiltInDocumentProperties)
void	setClearCustomDocumentProperties(Boolean clearCustomDocumentProperties)
void	setColumnsPerPage(Integer columnsPerPage)
void	setConvertRange(String convertRange)
void	setCultureInfo(String cultureInfo)
void	setDefaultFont(String defaultFont)
void	setFontSubstitutes(Map<String,String> fontSubstitutes)
void	setOnePagePerSheet(Boolean onePagePerSheet)
void	setOptimizePdfSize(Boolean optimizePdfSize)
void	setPassword(String password)
void	setPrintComments(SpreadsheetLoadOptions.PrintCommentsEnum printComments)
void	setResetFontFolders(Boolean resetFontFolders)
void	setRowsPerPage(Integer rowsPerPage)
void	setSheetIndexes(List<Integer> sheetIndexes)
void	setSheets(List<String> sheets)
void	setShowGridLines(Boolean showGridLines)
void	setShowHiddenSheets(Boolean showHiddenSheets)
void	setSkipEmptyRowsAndColumns(Boolean skipEmptyRowsAndColumns)
SpreadsheetLoadOptions	sheetIndexes(List<Integer> sheetIndexes)
SpreadsheetLoadOptions	sheets(List<String> sheets)
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

clearCustomDocumentProperties

public SpreadsheetLoadOptions clearCustomDocumentProperties(Boolean clearCustomDocumentProperties)

getClearCustomDocumentProperties

public Boolean getClearCustomDocumentProperties()

Clear custom document properties. Default is false.

Returns:

clearCustomDocumentProperties

setClearCustomDocumentProperties

public void setClearCustomDocumentProperties(Boolean clearCustomDocumentProperties)

clearBuiltInDocumentProperties

public SpreadsheetLoadOptions clearBuiltInDocumentProperties(Boolean clearBuiltInDocumentProperties)

getClearBuiltInDocumentProperties

public Boolean getClearBuiltInDocumentProperties()

Clear built-in document properties. Default is false.

Returns:

clearBuiltInDocumentProperties

setClearBuiltInDocumentProperties

public void setClearBuiltInDocumentProperties(Boolean clearBuiltInDocumentProperties)

rowsPerPage

public SpreadsheetLoadOptions rowsPerPage(Integer rowsPerPage)

getRowsPerPage

public Integer getRowsPerPage()

Split a worksheet into pages by rows. Default is 0, no pagination.

Returns:

rowsPerPage

setRowsPerPage

public void setRowsPerPage(Integer rowsPerPage)

columnsPerPage

public SpreadsheetLoadOptions columnsPerPage(Integer columnsPerPage)

getColumnsPerPage

public Integer getColumnsPerPage()

Split a worksheet into pages by columns. Default is 0, no pagination.

Returns:

columnsPerPage

setColumnsPerPage

public void setColumnsPerPage(Integer columnsPerPage)

autoFitRows

public SpreadsheetLoadOptions autoFitRows(Boolean autoFitRows)

getAutoFitRows

public Boolean getAutoFitRows()

Autofits all rows when converting

Returns:

autoFitRows

setAutoFitRows

public void setAutoFitRows(Boolean autoFitRows)

allColumnsInOnePagePerSheet

public SpreadsheetLoadOptions allColumnsInOnePagePerSheet(Boolean allColumnsInOnePagePerSheet)

getAllColumnsInOnePagePerSheet

public Boolean getAllColumnsInOnePagePerSheet()

If AllColumnsInOnePagePerSheet is true, all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.

Returns:

allColumnsInOnePagePerSheet

setAllColumnsInOnePagePerSheet

public void setAllColumnsInOnePagePerSheet(Boolean allColumnsInOnePagePerSheet)

cultureInfo

public SpreadsheetLoadOptions cultureInfo(String cultureInfo)

getCultureInfo

public String getCultureInfo()

System culture info at the time file is loaded

Returns:

cultureInfo

setCultureInfo

public void setCultureInfo(String cultureInfo)

checkExcelRestriction

public SpreadsheetLoadOptions checkExcelRestriction(Boolean checkExcelRestriction)

getCheckExcelRestriction

public Boolean getCheckExcelRestriction()

Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell's value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file.

Returns:

checkExcelRestriction

setCheckExcelRestriction

public void setCheckExcelRestriction(Boolean checkExcelRestriction)

password

public SpreadsheetLoadOptions password(String password)

getPassword

public String getPassword()

Set password to unprotect protected document

Returns:

password

setPassword

public void setPassword(String password)

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)

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)

optimizePdfSize

public SpreadsheetLoadOptions optimizePdfSize(Boolean optimizePdfSize)

getOptimizePdfSize

public Boolean getOptimizePdfSize()

If True and converting to Pdf the conversion is optimized for better file size than print quality.

Returns:

optimizePdfSize

setOptimizePdfSize

public void setOptimizePdfSize(Boolean optimizePdfSize)

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)

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)

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)

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)

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)

sheetIndexes

public SpreadsheetLoadOptions sheetIndexes(List<Integer> sheetIndexes)

addSheetIndexesItem

public SpreadsheetLoadOptions addSheetIndexesItem(Integer sheetIndexesItem)

getSheetIndexes

public List<Integer> getSheetIndexes()

List of sheet indexes to convert. The indexes must be zero-based

Returns:

sheetIndexes

setSheetIndexes

public void setSheetIndexes(List<Integer> sheetIndexes)

sheets

public SpreadsheetLoadOptions sheets(List<String> sheets)

addSheetsItem

public SpreadsheetLoadOptions addSheetsItem(String sheetsItem)

getSheets

public List<String> getSheets()

List of sheet names to convert

Returns:

sheets

setSheets

public void setSheets(List<String> sheets)

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)

resetFontFolders

public SpreadsheetLoadOptions resetFontFolders(Boolean resetFontFolders)

getResetFontFolders

public Boolean getResetFontFolders()

Reset font folders before loading document

Returns:

resetFontFolders

setResetFontFolders

public void setResetFontFolders(Boolean resetFontFolders)

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