SpreadsheetLoadOptions

Packages

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>, Serializable, Cloneable

Direct Known Subclasses:

CsvLoadOptions, TsvLoadOptions
```
public class SpreadsheetLoadOptions
extends LoadOptions
implements Cloneable, Serializable
```
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
`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.
`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.
`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`	`isCheckExcelRestriction()` Whether check restriction of excel file when user modify cells related objects.
`void`	`setAllColumnsInOnePagePerSheet(boolean allColumnsInOnePagePerSheet)` Sets AllColumnsInOnePagePerSheet property
`void`	`setCheckExcelRestriction(boolean checkExcelRestriction)`
`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`	`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`	`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
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SpreadsheetLoadOptions
```
public SpreadsheetLoadOptions()
```
    Initializes new instance of SpreadsheetLoadOptions class.
- Method Detail
  - getSheets
```
public List<String> getSheets()
```
    Get sheet name to convert
  - setSheets
```
public void setSheets(List<String> sheets)
```
    Set sheet name to convert
  - getCultureInfo
```
public com.aspose.ms.System.Globalization.CultureInfo getCultureInfo()
```
    Get the system culture info at the time file is loaded
  - setCultureInfo
```
public void setCultureInfo(com.aspose.ms.System.Globalization.CultureInfo cultureInfo)
```
    Set the system culture info at the time file is loaded
  - getFormat
```
public final SpreadsheetFileType getFormat()
```
    Description copied from class: LoadOptions
    
    Input document file type
    
    Overrides:
    
    getFormat in class LoadOptions
  - getDefaultFont
```
public final String getDefaultFont()
```
    Default font for spreadsheet document. The following font will be used if a font is missing.
  - setDefaultFont
```
public final void setDefaultFont(String value)
```
    Default font for spreadsheet document. The following font will be used if a font is missing.
  - getFontSubstitutes
```
public final List<FontSubstitute> getFontSubstitutes()
```
    Substitute specific fonts when converting spreadsheet document.
  - setFontSubstitutes
```
public final void setFontSubstitutes(List<FontSubstitute> value)
```
    Substitute specific fonts when converting spreadsheet document.
  - getShowGridLines
```
public final boolean getShowGridLines()
```
    Show grid lines when converting Excel files.
  - setShowGridLines
```
public final void setShowGridLines(boolean value)
```
    Show grid lines when converting Excel files.
  - getShowHiddenSheets
```
public final boolean getShowHiddenSheets()
```
    Show hidden sheets when converting Excel files.
  - setShowHiddenSheets
```
public final void setShowHiddenSheets(boolean value)
```
    Show hidden sheets when converting Excel files.
  - 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.
  - 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.
  - getAllColumnsInOnePagePerSheet
```
public boolean getAllColumnsInOnePagePerSheet()
```
    Gets AllColumnsInOnePagePerSheet property
    
    Returns:
    
    true if fit all columns to ont page
  - setAllColumnsInOnePagePerSheet
```
public void setAllColumnsInOnePagePerSheet(boolean allColumnsInOnePagePerSheet)
```
    Sets AllColumnsInOnePagePerSheet property
    
    Parameters:
    
    allColumnsInOnePagePerSheet - AllColumnsInOnePagePerSheet property
  - getOptimizePdfSize
```
public final boolean getOptimizePdfSize()
```
    If True and converting to Pdf the conversion is optimized for better file size than print quality.
  - setOptimizePdfSize
```
public final void setOptimizePdfSize(boolean value)
```
    If True and converting to Pdf the conversion is optimized for better file size than print quality.
  - getConvertRange
```
public final String getConvertRange()
```
    Convert specific range when converting to other than spreadsheet format. Example: "D1:F8".
  - setConvertRange
```
public final void setConvertRange(String value)
```
    Convert specific range when converting to other than spreadsheet format. Example: "D1:F8".
  - getSkipEmptyRowsAndColumns
```
public final boolean getSkipEmptyRowsAndColumns()
```
    Skips empty rows and columns when converting. Default is True.
  - setSkipEmptyRowsAndColumns
```
public final void setSkipEmptyRowsAndColumns(boolean value)
```
    Skips empty rows and columns when converting. Default is True.
  - getPassword
```
public final String getPassword()
```
    Set password to unprotect protected document.
  - setPassword
```
public final void setPassword(String value)
```
    Set password to unprotect protected document.
  - getHideComments
```
public final boolean getHideComments()
```
    Hide comments.
  - setHideComments
```
public final void setHideComments(boolean value)
```
    Hide comments.
  - 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
  - setCheckExcelRestriction
```
public void setCheckExcelRestriction(boolean checkExcelRestriction)
```
  - deepClone
```
public final Object deepClone()
```
    Clones current instance.
    
    Returns:

Packages

com.groupdocs.conversion.options.load

Classes

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

Method Detail

getSheets

setSheets

getCultureInfo

setCultureInfo

getFormat

getDefaultFont

setDefaultFont

getFontSubstitutes

setFontSubstitutes

getShowGridLines

setShowGridLines

getShowHiddenSheets

setShowHiddenSheets

getOnePagePerSheet

setOnePagePerSheet

getAllColumnsInOnePagePerSheet

setAllColumnsInOnePagePerSheet

getOptimizePdfSize

setOptimizePdfSize

getConvertRange

setConvertRange

getSkipEmptyRowsAndColumns

setSkipEmptyRowsAndColumns

getPassword

setPassword

getHideComments

setHideComments

isCheckExcelRestriction

setCheckExcelRestriction

deepClone