SpreadsheetLoadOptions

Inheritance: java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

All Implemented Interfaces: java.lang.Cloneable, java.io.Serializable

public class SpreadsheetLoadOptions extends LoadOptions implements Cloneable, Serializable

Options for loading Spreadsheet documents.

Constructors

Constructor Description
SpreadsheetLoadOptions() Initializes new instance of SpreadsheetLoadOptions class.

Methods

Method Description
getSheets() Get sheet name to convert
setSheets(List sheets) Set sheet name to convert
getCultureInfo() Get the system culture info at the time file is loaded
setCultureInfo(System.Globalization.CultureInfo cultureInfo) Set the system culture info at the time file is loaded
getFormat()
getDefaultFont() Default font for spreadsheet document.
setDefaultFont(String value) Default font for spreadsheet document.
getFontSubstitutes() Substitute specific fonts when converting spreadsheet document.
setFontSubstitutes(List value) Substitute specific fonts when converting spreadsheet document.
getShowGridLines() Show grid lines when converting Excel files.
setShowGridLines(boolean value) Show grid lines when converting Excel files.
getShowHiddenSheets() Show hidden sheets when converting Excel files.
setShowHiddenSheets(boolean value) Show hidden sheets when converting Excel files.
getOnePagePerSheet() If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document.
setOnePagePerSheet(boolean value) If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document.
getAllColumnsInOnePagePerSheet() Gets AllColumnsInOnePagePerSheet property
setAllColumnsInOnePagePerSheet(boolean allColumnsInOnePagePerSheet) Sets AllColumnsInOnePagePerSheet property
getOptimizePdfSize() If True and converting to Pdf the conversion is optimized for better file size than print quality.
setOptimizePdfSize(boolean value) If True and converting to Pdf the conversion is optimized for better file size than print quality.
getConvertRange() Convert specific range when converting to other than spreadsheet format.
setConvertRange(String value) Convert specific range when converting to other than spreadsheet format.
getSkipEmptyRowsAndColumns() Skips empty rows and columns when converting.
setSkipEmptyRowsAndColumns(boolean value) Skips empty rows and columns when converting.
getPassword() Set password to unprotect protected document.
setPassword(String value) Set password to unprotect protected document.
getHideComments() Hide comments.
setHideComments(boolean value) Hide comments.
isCheckExcelRestriction() Whether check restriction of excel file when user modify cells related objects.
setCheckExcelRestriction(boolean checkExcelRestriction)
getSheetIndexes() Gets List of sheet indexes to convert.
setSheetIndexes(List sheetIndexes) Sets List of sheet indexes to convert.
isAutoFitRows() Autofits all rows when converting
setAutoFitRows(boolean autoFitRows)
deepClone() Clones current instance.

SpreadsheetLoadOptions()

public SpreadsheetLoadOptions()

Initializes new instance of SpreadsheetLoadOptions class.

getSheets()

public List<String> getSheets()

Get sheet name to convert

Returns: java.util.List<java.lang.String>

setSheets(List sheets)

public void setSheets(List<String> sheets)

Set sheet name to convert

Parameters:

Parameter Type Description
sheets java.util.List<java.lang.String>

getCultureInfo()

public System.Globalization.CultureInfo getCultureInfo()

Get the system culture info at the time file is loaded

Returns: com.aspose.ms.System.Globalization.CultureInfo

setCultureInfo(System.Globalization.CultureInfo cultureInfo)

public void setCultureInfo(System.Globalization.CultureInfo cultureInfo)

Set the system culture info at the time file is loaded

Parameters:

Parameter Type Description
cultureInfo com.aspose.ms.System.Globalization.CultureInfo

getFormat()

public final SpreadsheetFileType getFormat()

Input document file type

Returns: SpreadsheetFileType

getDefaultFont()

public final String getDefaultFont()

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

Returns: java.lang.String

setDefaultFont(String value)

public final void setDefaultFont(String value)

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

Parameters:

Parameter Type Description
value java.lang.String

getFontSubstitutes()

public final List<FontSubstitute> getFontSubstitutes()

Substitute specific fonts when converting spreadsheet document.

Returns: java.util.List<com.groupdocs.conversion.contracts.FontSubstitute>

setFontSubstitutes(List value)

public final void setFontSubstitutes(List<FontSubstitute> value)

Substitute specific fonts when converting spreadsheet document.

Parameters:

Parameter Type Description
value java.util.List<com.groupdocs.conversion.contracts.FontSubstitute>

getShowGridLines()

public final boolean getShowGridLines()

Show grid lines when converting Excel files.

Returns: boolean

setShowGridLines(boolean value)

public final void setShowGridLines(boolean value)

Show grid lines when converting Excel files.

Parameters:

Parameter Type Description
value boolean

getShowHiddenSheets()

public final boolean getShowHiddenSheets()

Show hidden sheets when converting Excel files.

Returns: boolean

setShowHiddenSheets(boolean value)

public final void setShowHiddenSheets(boolean value)

Show hidden sheets when converting Excel files.

Parameters:

Parameter Type Description
value boolean

getOnePagePerSheet()

public final boolean getOnePagePerSheet()

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

Returns: boolean

setOnePagePerSheet(boolean value)

public final void setOnePagePerSheet(boolean value)

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

Parameters:

Parameter Type Description
value boolean

getAllColumnsInOnePagePerSheet()

public boolean getAllColumnsInOnePagePerSheet()

Gets AllColumnsInOnePagePerSheet property

Returns: boolean - true if fit all columns to ont page

setAllColumnsInOnePagePerSheet(boolean allColumnsInOnePagePerSheet)

public void setAllColumnsInOnePagePerSheet(boolean allColumnsInOnePagePerSheet)

Sets AllColumnsInOnePagePerSheet property

Parameters:

Parameter Type Description
allColumnsInOnePagePerSheet boolean AllColumnsInOnePagePerSheet property

getOptimizePdfSize()

public final boolean getOptimizePdfSize()

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

Returns: boolean

setOptimizePdfSize(boolean value)

public final void setOptimizePdfSize(boolean value)

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

Parameters:

Parameter Type Description
value boolean

getConvertRange()

public final String getConvertRange()

Convert specific range when converting to other than spreadsheet format. Example: “D1:F8”.

Returns: java.lang.String

setConvertRange(String value)

public final void setConvertRange(String value)

Convert specific range when converting to other than spreadsheet format. Example: “D1:F8”.

Parameters:

Parameter Type Description
value java.lang.String

getSkipEmptyRowsAndColumns()

public final boolean getSkipEmptyRowsAndColumns()

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

Returns: boolean

setSkipEmptyRowsAndColumns(boolean value)

public final void setSkipEmptyRowsAndColumns(boolean value)

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

Parameters:

Parameter Type Description
value boolean

getPassword()

public final String getPassword()

Set password to unprotect protected document.

Returns: java.lang.String

setPassword(String value)

public final void setPassword(String value)

Set password to unprotect protected document.

Parameters:

Parameter Type Description
value java.lang.String

getHideComments()

public final boolean getHideComments()

Hide comments.

Returns: boolean

setHideComments(boolean value)

public final void setHideComments(boolean value)

Hide comments.

Parameters:

Parameter Type Description
value boolean

isCheckExcelRestriction()

public boolean isCheckExcelRestriction()

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: boolean - check restriction flag

setCheckExcelRestriction(boolean checkExcelRestriction)

public void setCheckExcelRestriction(boolean checkExcelRestriction)

Parameters:

Parameter Type Description
checkExcelRestriction boolean

getSheetIndexes()

public List<Integer> getSheetIndexes()

Gets List of sheet indexes to convert.

Returns: java.util.List<java.lang.Integer>

setSheetIndexes(List sheetIndexes)

public void setSheetIndexes(List<Integer> sheetIndexes)

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

Parameters:

Parameter Type Description
sheetIndexes java.util.List<java.lang.Integer>

isAutoFitRows()

public boolean isAutoFitRows()

Autofits all rows when converting

Returns: boolean

setAutoFitRows(boolean autoFitRows)

public void setAutoFitRows(boolean autoFitRows)

Parameters:

Parameter Type Description
autoFitRows boolean

deepClone()

public final Object deepClone()

Clones current instance.

Returns: java.lang.Object -