SpreadsheetLoadOptions (GroupDocs.Total for Java (26.6) API Reference)

java.lang.Object
- com.groupdocs.conversion.contracts.ValueObject
- - com.groupdocs.conversion.options.load.LoadOptions
  - - com.groupdocs.conversion.options.load.SpreadsheetLoadOptions

All Implemented Interfaces:

com.aspose.ms.System.IEquatable<ValueObject>, com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions, Serializable, Cloneable

Direct Known Subclasses:

CsvLoadOptions, TsvLoadOptions
```
public class SpreadsheetLoadOptions
extends LoadOptions
implements Cloneable, Serializable, com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
```
Options for loading Spreadsheet documents.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SpreadsheetLoadOptions()
Initializes new instance of SpreadsheetLoadOptions class.

Constructors
Constructor and Description
`SpreadsheetLoadOptions()` Initializes new instance of `SpreadsheetLoadOptions` class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`deepClone()` Clones current instance.
`boolean`	`getAllColumnsInOnePagePerSheet()` Gets AllColumnsInOnePagePerSheet property
`int`	`getColumnsPerPage()` Split a worksheet into pages by columns.
`String`	`getConvertRange()` Convert specific range when converting to other than spreadsheet format.
`com.aspose.ms.System.Globalization.CultureInfo`	`getCultureInfo()` Get the system culture info at the time file is loaded
`String`	`getDefaultFont()` Default font for spreadsheet document.
`int`	`getDepth()` Option to control how many levels in depth to perform conversion
`protected List<Object>`	`getEqualityComponents()` Gets equality components.
`List<FontSubstitute>`	`getFontSubstitutes()` Substitute specific fonts when converting spreadsheet document.
`SpreadsheetFileType`	`getFormat()` Input document file type
`boolean`	`getHideComments()` Hide comments.
`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.
`boolean`	`getResetFontFolders()` Reset font folders before loading document
`int`	`getRowsPerPage()` Split a worksheet into pages by rows.
`List<Integer>`	`getSheetIndexes()` Gets List of sheet indexes to convert.
`List<String>`	`getSheets()` Get sheet name 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.
`boolean`	`isAutoFitRows()` Autofits all rows when converting
`boolean`	`isCheckExcelRestriction()` Whether check restriction of excel file when user modify cells related objects.
`boolean`	`isConvertOwned()` Option to control whether the owned documents in the documents container must be converted
`boolean`	`isConvertOwner()` Gets option to control whether the documents container itself must be converted
`protected Object`	`memberwiseClone()`
`void`	`setAllColumnsInOnePagePerSheet(boolean allColumnsInOnePagePerSheet)` Sets AllColumnsInOnePagePerSheet property
`void`	`setAutoFitRows(boolean autoFitRows)`
`void`	`setCheckExcelRestriction(boolean checkExcelRestriction)`
`void`	`setColumnsPerPage(int columnsPerPage)` Split a worksheet into pages by columns.
`void`	`setConvertOwned(boolean convertOwned)`
`void`	`setConvertOwner(boolean convertOwner)`
`void`	`setConvertRange(String value)` Convert specific range when converting to other than spreadsheet format.
`void`	`setCultureInfo(com.aspose.ms.System.Globalization.CultureInfo cultureInfo)` Set the system culture info at the time file is loaded
`void`	`setDefaultFont(String value)` Default font for spreadsheet document.
`void`	`setDepth(int depth)`
`void`	`setFontSubstitutes(List<FontSubstitute> value)` Substitute specific fonts when converting spreadsheet document.
`void`	`setHideComments(boolean value)` Hide comments.
`void`	`setOnePagePerSheet(boolean value)` If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document.
`void`	`setOptimizePdfSize(boolean value)` If True and converting to Pdf the conversion is optimized for better file size than print quality.
`void`	`setPassword(String value)` Set password to unprotect protected document.
`void`	`setResetFontFolders(boolean resetFontFolders)`
`void`	`setRowsPerPage(int rowsPerPage)` Split a worksheet into pages by rows.
`void`	`setSheetIndexes(List<Integer> sheetIndexes)` Sets List of sheet indexes to convert.
`void`	`setSheets(List<String> sheets)` Set sheet name to convert
`void`	`setShowGridLines(boolean value)` Show grid lines when converting Excel files.
`void`	`setShowHiddenSheets(boolean value)` Show hidden sheets when converting Excel files.
`void`	`setSkipEmptyRowsAndColumns(boolean value)` Skips empty rows and columns when converting.

Methods inherited from class com.groupdocs.conversion.options.load.LoadOptions
setFormat

Methods inherited from class com.groupdocs.conversion.contracts.ValueObject
equals, equals, hashCode, op_Equality, op_Inequality

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SpreadsheetLoadOptions
```
public SpreadsheetLoadOptions()
```
    Initializes new instance of SpreadsheetLoadOptions class.
- Method Detail
  - deepClone
```
public final Object deepClone()
```
    Clones current instance.
    
    Returns:
  - getAllColumnsInOnePagePerSheet
```
public boolean getAllColumnsInOnePagePerSheet()
```
    Gets AllColumnsInOnePagePerSheet property
    
    Returns:
    
    true if fit all columns to ont page
  - getColumnsPerPage
```
public int getColumnsPerPage()
```
    Split a worksheet into pages by columns. Default is 0, no pagination.
  - getConvertRange
```
public final String getConvertRange()
```
    Convert specific range when converting to other than spreadsheet format. Example: "D1:F8".
  - getCultureInfo
```
public com.aspose.ms.System.Globalization.CultureInfo getCultureInfo()
```
    Get the system culture info at the time file is loaded
  - getDefaultFont
```
public final String getDefaultFont()
```
    Default font for spreadsheet document. The following font will be used if a font is missing.
  - getDepth
```
public int getDepth()
```
    Description copied from interface: com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
    
    Option to control how many levels in depth to perform conversion
    
    Specified by:
    
    getDepth in interface com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
    
    Returns:
    
    depth levels count
  - getEqualityComponents
```
protected List<Object> getEqualityComponents()
```
    Description copied from class: ValueObject
    
    Gets equality components.
    
    Specified by:
    
    getEqualityComponents in class ValueObject
    
    Returns:
    
    Collection of objects.
  - getFontSubstitutes
```
public final List<FontSubstitute> getFontSubstitutes()
```
    Substitute specific fonts when converting spreadsheet document.
  - getFormat
```
public final SpreadsheetFileType getFormat()
```
    Description copied from class: LoadOptions
    
    Input document file type
    
    Overrides:
    
    getFormat in class LoadOptions
  - getHideComments
```
public final boolean getHideComments()
```
    Hide comments.
  - 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.
  - getOptimizePdfSize
```
public final boolean getOptimizePdfSize()
```
    If True and converting to Pdf the conversion is optimized for better file size than print quality.
  - getPassword
```
public final String getPassword()
```
    Set password to unprotect protected document.
  - getResetFontFolders
```
public boolean getResetFontFolders()
```
    Reset font folders before loading document
  - getRowsPerPage
```
public int getRowsPerPage()
```
    Split a worksheet into pages by rows. Default is 0, no pagination.
  - getSheetIndexes
```
public List<Integer> getSheetIndexes()
```
    Gets List of sheet indexes to convert.
  - getSheets
```
public List<String> getSheets()
```
    Get sheet name to convert
  - getShowGridLines
```
public final boolean getShowGridLines()
```
    Show grid lines when converting Excel files.
  - getShowHiddenSheets
```
public final boolean getShowHiddenSheets()
```
    Show hidden sheets when converting Excel files.
  - getSkipEmptyRowsAndColumns
```
public final boolean getSkipEmptyRowsAndColumns()
```
    Skips empty rows and columns when converting. Default is True.
  - isAutoFitRows
```
public boolean isAutoFitRows()
```
    Autofits all rows when converting
  - 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:
    
    check restriction flag
  - isConvertOwned
```
public boolean isConvertOwned()
```
    Description copied from interface: com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
    
    Option to control whether the owned documents in the documents container must be converted
    
    Specified by:
    
    isConvertOwned in interface com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
    
    Returns:
    
    true if the owned documents in the documents container must be converted
  - isConvertOwner
```
public boolean isConvertOwner()
```
    Description copied from interface: com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
    
    Gets option to control whether the documents container itself must be converted
    
    Specified by:
    
    isConvertOwner in interface com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
    
    Returns:
    
    If this property is true the documents container will be the first converted document
  - memberwiseClone
```
protected Object memberwiseClone()
```
  - setAllColumnsInOnePagePerSheet
```
public void setAllColumnsInOnePagePerSheet(boolean allColumnsInOnePagePerSheet)
```
    Sets AllColumnsInOnePagePerSheet property
    
    Parameters:
    
    allColumnsInOnePagePerSheet - AllColumnsInOnePagePerSheet property
  - setAutoFitRows
```
public void setAutoFitRows(boolean autoFitRows)
```
  - setCheckExcelRestriction
```
public void setCheckExcelRestriction(boolean checkExcelRestriction)
```
  - setColumnsPerPage
```
public void setColumnsPerPage(int columnsPerPage)
```
    Split a worksheet into pages by columns. Default is 0, no pagination.
  - setConvertOwned
```
public void setConvertOwned(boolean convertOwned)
```
  - setConvertOwner
```
public void setConvertOwner(boolean convertOwner)
```
  - setConvertRange
```
public final void setConvertRange(String value)
```
    Convert specific range when converting to other than spreadsheet format. Example: "D1:F8".
  - setCultureInfo
```
public void setCultureInfo(com.aspose.ms.System.Globalization.CultureInfo cultureInfo)
```
    Set the system culture info at the time file is loaded
  - setDefaultFont
```
public final void setDefaultFont(String value)
```
    Default font for spreadsheet document. The following font will be used if a font is missing.
  - setDepth
```
public void setDepth(int depth)
```
  - setFontSubstitutes
```
public final void setFontSubstitutes(List<FontSubstitute> value)
```
    Substitute specific fonts when converting spreadsheet document.
  - setHideComments
```
public final void setHideComments(boolean value)
```
    Hide comments.
  - setOnePagePerSheet
```
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.
  - setOptimizePdfSize
```
public final void setOptimizePdfSize(boolean value)
```
    If True and converting to Pdf the conversion is optimized for better file size than print quality.
  - setPassword
```
public final void setPassword(String value)
```
    Set password to unprotect protected document.
  - setResetFontFolders
```
public void setResetFontFolders(boolean resetFontFolders)
```
  - setRowsPerPage
```
public void setRowsPerPage(int rowsPerPage)
```
    Split a worksheet into pages by rows. Default is 0, no pagination.
  - setSheetIndexes
```
public void setSheetIndexes(List<Integer> sheetIndexes)
```
    Sets List of sheet indexes to convert. The indexes must be zero-based
  - setSheets
```
public void setSheets(List<String> sheets)
```
    Set sheet name to convert
  - setShowGridLines
```
public final void setShowGridLines(boolean value)
```
    Show grid lines when converting Excel files.
  - setShowHiddenSheets
```
public final void setShowHiddenSheets(boolean value)
```
    Show hidden sheets when converting Excel files.
  - setSkipEmptyRowsAndColumns
```
public final void setSkipEmptyRowsAndColumns(boolean value)
```
    Skips empty rows and columns when converting. Default is True.

Class SpreadsheetLoadOptions

Constructor Summary

Method Summary

Methods inherited from class com.groupdocs.conversion.options.load.LoadOptions

Methods inherited from class com.groupdocs.conversion.contracts.ValueObject

Methods inherited from class java.lang.Object

Constructor Detail

SpreadsheetLoadOptions

Method Detail

deepClone

getAllColumnsInOnePagePerSheet

getColumnsPerPage

getConvertRange

getCultureInfo

getDefaultFont

getDepth

getEqualityComponents

getFontSubstitutes

getFormat

getHideComments

getOnePagePerSheet

getOptimizePdfSize

getPassword

getResetFontFolders

getRowsPerPage

getSheetIndexes

getSheets

getShowGridLines

getShowHiddenSheets

getSkipEmptyRowsAndColumns

isAutoFitRows

isCheckExcelRestriction

isConvertOwned

isConvertOwner

memberwiseClone

setAllColumnsInOnePagePerSheet

setAutoFitRows

setCheckExcelRestriction

setColumnsPerPage

setConvertOwned

setConvertOwner

setConvertRange

setCultureInfo

setDefaultFont

setDepth

setFontSubstitutes

setHideComments

setOnePagePerSheet

setOptimizePdfSize

setPassword

setResetFontFolders

setRowsPerPage

setSheetIndexes

setSheets

setShowGridLines

setShowHiddenSheets

setSkipEmptyRowsAndColumns