LoadOptions (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.LoadOptions

Direct Known Subclasses:

AbstractTextLoadOptions, DbfLoadOptions, DifLoadOptions, JsonLoadOptions, NumbersLoadOptions, OdsLoadOptions, XmlLoadOptions
```
public class LoadOptions
extends java.lang.Object
```
Represents the options of loading the file.

Constructor Summary

Constructors
Constructor and Description

LoadOptions()
Creates an options of loading the file.

LoadOptions(int loadFormat)
Creates an options of loading the file.

Constructors
Constructor and Description
`LoadOptions()` Creates an options of loading the file.
`LoadOptions(int loadFormat)` Creates an options of loading the file.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`getAutoFilter()` Indicates whether auto filtering the data when loading the files.
`AutoFitterOptions`	`getAutoFitterOptions()` Gets the auto fitter options
`boolean`	`getCheckDataValid()` Check whether data is valid in the template file.
`boolean`	`getCheckExcelRestriction()` Whether check restriction of excel file when user modify cells related objects.
`DefaultStyleSettings`	`getDefaultStyleSettings()` Gets the default style settings for initializing styles of the workbook
`IndividualFontConfigs`	`getFontConfigs()` Gets individual font configs.
`boolean`	`getIgnoreNotPrinted()` Ignore the data which are not printed if directly printing the file
`boolean`	`getIgnoreUselessShapes()` Indicates whether ignoring useless shapes.
`AbstractInterruptMonitor`	`getInterruptMonitor()` Gets the interrupt monitor.
`boolean`	`getKeepUnparsedData()` Whether keep the unparsed data in memory for the Workbook when it is loaded from template file.
`int`	`getLanguageCode()` Gets the user interface language of the Workbook version based on CountryCode that has saved the file.
`LightCellsDataHandler`	`getLightCellsDataHandler()` The data handler for processing cells data when reading template file.
`LoadFilter`	`getLoadFilter()` The filter to denote how to load data.
`int`	`getLoadFormat()` Gets the load format.
`java.util.Locale`	`getLocale()` Gets the regional settings used for the Workbook that will be loaded.
`int`	`getMemorySetting()` Gets the memory mode for loaded workbook.
`boolean`	`getParsingFormulaOnOpen()` Indicates whether parsing the formula when reading the file.
`boolean`	`getParsingPivotCachedRecords()` Indicates whether parsing pivot cached records when loading the file.
`java.lang.String`	`getPassword()` Gets the password of the workbook.
`boolean`	`getPreservePaddingSpacesInFormula()` Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas.
`int`	`getRegion()` Gets the regional settings used for the Workbook that will be loaded.
`java.lang.String`	`getStandardFont()` Deprecated. Use DefaultStyleSettings.FontName property instead.
`double`	`getStandardFontSize()` Deprecated. Use DefaultStyleSettings.FontSize property instead.
`IWarningCallback`	`getWarningCallback()` Gets warning callback.
`void`	`setAutoFilter(boolean value)` Indicates whether auto filtering the data when loading the files.
`void`	`setAutoFitterOptions(AutoFitterOptions value)` Sets the auto fitter options
`void`	`setCheckDataValid(boolean value)` Check whether data is valid in the template file.
`void`	`setCheckExcelRestriction(boolean value)` Whether check restriction of excel file when user modify cells related objects.
`void`	`setFontConfigs(IndividualFontConfigs value)` Sets individual font configs.
`void`	`setIgnoreNotPrinted(boolean value)` Ignore the data which are not printed if directly printing the file
`void`	`setIgnoreUselessShapes(boolean value)` Indicates whether ignoring useless shapes.
`void`	`setInterruptMonitor(AbstractInterruptMonitor value)` Sets the interrupt monitor.
`void`	`setKeepUnparsedData(boolean value)` Whether keep the unparsed data in memory for the Workbook when it is loaded from template file.
`void`	`setLanguageCode(int value)` Sets the user interface language of the Workbook version based on CountryCode that has saved the file.
`void`	`setLightCellsDataHandler(LightCellsDataHandler value)` The data handler for processing cells data when reading template file.
`void`	`setLoadFilter(LoadFilter value)` The filter to denote how to load data.
`void`	`setLocale(java.util.Locale value)` Sets the regional settings used for the Workbook that will be loaded.
`void`	`setMemorySetting(int value)` Sets the memory mode for loaded workbook.
`void`	`setPaperSize(int type)` Sets the default print paper size from default printer's setting.
`void`	`setParsingFormulaOnOpen(boolean value)` Indicates whether parsing the formula when reading the file.
`void`	`setParsingPivotCachedRecords(boolean value)` Indicates whether parsing pivot cached records when loading the file.
`void`	`setPassword(java.lang.String value)` Sets the password of the workbook.
`void`	`setPreservePaddingSpacesInFormula(boolean value)` Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas.
`void`	`setRegion(int value)` Sets the regional settings used for the Workbook that will be loaded.
`void`	`setStandardFont(java.lang.String value)` Deprecated. Use DefaultStyleSettings.FontName property instead.
`void`	`setStandardFontSize(double value)` Deprecated. Use DefaultStyleSettings.FontSize property instead.
`void`	`setWarningCallback(IWarningCallback value)` Sets warning callback.

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

- Constructor Detail
  - LoadOptions
```
public LoadOptions()
```
    Creates an options of loading the file.
  - LoadOptions
```
public LoadOptions(int loadFormat)
```
    Creates an options of loading the file.
    
    Parameters:
    loadFormat - LoadFormat. The loading format.
- Method Detail
  - getLoadFormat
```
public int getLoadFormat()
```
    Gets the load format.
    See LoadFormat.
  - getPassword
```
public java.lang.String getPassword()
```
    Gets the password of the workbook.
  - setPassword
```
public void setPassword(java.lang.String value)
```
    Sets the password of the workbook.
  - getParsingFormulaOnOpen
```
public boolean getParsingFormulaOnOpen()
```
    Indicates whether parsing the formula when reading the file.
    Remarks
    Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file because the formulas in the files are stored with a string formula.
  - setParsingFormulaOnOpen
```
public void setParsingFormulaOnOpen(boolean value)
```
    Indicates whether parsing the formula when reading the file.
    Remarks
    Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file because the formulas in the files are stored with a string formula.
  - getParsingPivotCachedRecords
```
public boolean getParsingPivotCachedRecords()
```
    Indicates whether parsing pivot cached records when loading the file. The default value is false.
    Remarks
    Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
  - setParsingPivotCachedRecords
```
public void setParsingPivotCachedRecords(boolean value)
```
    Indicates whether parsing pivot cached records when loading the file. The default value is false.
    Remarks
    Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
  - setPaperSize
```
public void setPaperSize(int type)
```
    Sets the default print paper size from default printer's setting.
    Remarks
    If there is no setting about paper size,MS Excel will use default printer's setting.
    
    Parameters:
    type - PaperSizeType. The default paper size.
  - getLanguageCode
```
public int getLanguageCode()
```
    Gets the user interface language of the Workbook version based on CountryCode that has saved the file.
    See CountryCode.
  - setLanguageCode
```
public void setLanguageCode(int value)
```
    Sets the user interface language of the Workbook version based on CountryCode that has saved the file.
    See CountryCode.
  - getRegion
```
public int getRegion()
```
    Gets the regional settings used for the Workbook that will be loaded.
    See CountryCode.
    
    Remarks
    The regional settings may be used for initializing some features for the workbook such as fonts, themes, and so on. For text based file formats, such as CSV, HTML, ..., the regional setting also will be used to detect number formats and parse text values to numeric or datetime values for cells. This setting will be kept for the instantiated workbook later, that is, WorkbookSettings.getRegion() of the workbook will use the same region with this property.
  - setRegion
```
public void setRegion(int value)
```
    Sets the regional settings used for the Workbook that will be loaded.
    See CountryCode.
    
    Remarks
    The regional settings may be used for initializing some features for the workbook such as fonts, themes, and so on. For text based file formats, such as CSV, HTML, ..., the regional setting also will be used to detect number formats and parse text values to numeric or datetime values for cells. This setting will be kept for the instantiated workbook later, that is, WorkbookSettings.getRegion() of the workbook will use the same region with this property.
  - getLocale
```
public java.util.Locale getLocale()
```
    Gets the regional settings used for the Workbook that will be loaded.
    Remarks
    This property has the same effect with getRegion() for setting regional settings.
  - setLocale
```
public void setLocale(java.util.Locale value)
```
    Sets the regional settings used for the Workbook that will be loaded.
    Remarks
    This property has the same effect with getRegion() for setting regional settings.
  - getDefaultStyleSettings
```
public DefaultStyleSettings getDefaultStyleSettings()
```
    Gets the default style settings for initializing styles of the workbook
  - getStandardFont
```
public java.lang.String getStandardFont()
```
    Deprecated. Use DefaultStyleSettings.FontName property instead.
    
    Sets the default standard font name
    Remarks
    NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings. This property will be removed 12 months later since March 2022. Aspose apologizes for any inconvenience you may have experienced.
  - setStandardFont
```
public void setStandardFont(java.lang.String value)
```
    Deprecated. Use DefaultStyleSettings.FontName property instead.
    
    Sets the default standard font name
    Remarks
    NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings. This property will be removed 12 months later since March 2022. Aspose apologizes for any inconvenience you may have experienced.
  - getStandardFontSize
```
public double getStandardFontSize()
```
    Deprecated. Use DefaultStyleSettings.FontSize property instead.
    
    Sets the default standard font size.
    Remarks
    NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings. This property will be removed 12 months later since March 2022. Aspose apologizes for any inconvenience you may have experienced.
  - setStandardFontSize
```
public void setStandardFontSize(double value)
```
    Deprecated. Use DefaultStyleSettings.FontSize property instead.
    
    Sets the default standard font size.
    Remarks
    NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings. This property will be removed 12 months later since March 2022. Aspose apologizes for any inconvenience you may have experienced.
  - getInterruptMonitor
```
public AbstractInterruptMonitor getInterruptMonitor()
```
    Gets the interrupt monitor.
  - setInterruptMonitor
```
public void setInterruptMonitor(AbstractInterruptMonitor value)
```
    Sets the interrupt monitor.
  - getIgnoreNotPrinted
```
public boolean getIgnoreNotPrinted()
```
    Ignore the data which are not printed if directly printing the file
    Remarks
    Only for xlsx file.
  - setIgnoreNotPrinted
```
public void setIgnoreNotPrinted(boolean value)
```
    Ignore the data which are not printed if directly printing the file
    Remarks
    Only for xlsx file.
  - getCheckDataValid
```
public boolean getCheckDataValid()
```
    Check whether data is valid in the template file.
  - setCheckDataValid
```
public void setCheckDataValid(boolean value)
```
    Check whether data is valid in the template file.
  - 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 such as by Cell.PutValue(string), 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.
  - setCheckExcelRestriction
```
public void setCheckExcelRestriction(boolean value)
```
    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 such as by Cell.PutValue(string), 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.
  - getKeepUnparsedData
```
public boolean getKeepUnparsedData()
```
    Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
    Remarks
    For scenarios that user only needs to read some contents from template file and does not need to save the workbook back, set this property as false may improve performance, especially when using it together with some kind of LoadFilter,
  - setKeepUnparsedData
```
public void setKeepUnparsedData(boolean value)
```
    Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
    Remarks
    For scenarios that user only needs to read some contents from template file and does not need to save the workbook back, set this property as false may improve performance, especially when using it together with some kind of LoadFilter,
  - getLoadFilter
```
public LoadFilter getLoadFilter()
```
    The filter to denote how to load data.
  - setLoadFilter
```
public void setLoadFilter(LoadFilter value)
```
    The filter to denote how to load data.
  - getLightCellsDataHandler
```
public LightCellsDataHandler getLightCellsDataHandler()
```
    The data handler for processing cells data when reading template file.
  - setLightCellsDataHandler
```
public void setLightCellsDataHandler(LightCellsDataHandler value)
```
    The data handler for processing cells data when reading template file.
  - getMemorySetting
```
public int getMemorySetting()
```
    Gets the memory mode for loaded workbook.
    See MemorySetting.
    
    Remarks
    For more details about memory mode, please see Cells.getMemorySetting().
  - setMemorySetting
```
public void setMemorySetting(int value)
```
    Sets the memory mode for loaded workbook.
    See MemorySetting.
    
    Remarks
    For more details about memory mode, please see Cells.getMemorySetting().
  - getWarningCallback
```
public IWarningCallback getWarningCallback()
```
    Gets warning callback.
  - setWarningCallback
```
public void setWarningCallback(IWarningCallback value)
```
    Sets warning callback.
  - getAutoFitterOptions
```
public AutoFitterOptions getAutoFitterOptions()
```
    Gets the auto fitter options
    Remarks
    Only for xlsx ,spreadsheetML file now.
  - setAutoFitterOptions
```
public void setAutoFitterOptions(AutoFitterOptions value)
```
    Sets the auto fitter options
    Remarks
    Only for xlsx ,spreadsheetML file now.
  - getAutoFilter
```
public boolean getAutoFilter()
```
    Indicates whether auto filtering the data when loading the files.
    Remarks
    Sometimes although autofilter is set, the corresponding rows is not hidden in the file. Now only works for SpreadSheetML file.
  - setAutoFilter
```
public void setAutoFilter(boolean value)
```
    Indicates whether auto filtering the data when loading the files.
    Remarks
    Sometimes although autofilter is set, the corresponding rows is not hidden in the file. Now only works for SpreadSheetML file.
  - getFontConfigs
```
public IndividualFontConfigs getFontConfigs()
```
    Gets individual font configs. Only works for the Workbook which uses this LoadOptions to load.
  - setFontConfigs
```
public void setFontConfigs(IndividualFontConfigs value)
```
    Sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.
  - getIgnoreUselessShapes
```
public boolean getIgnoreUselessShapes()
```
    Indicates whether ignoring useless shapes.
    Remarks
    Only works for xlsx,xlsb, and xlsm files. There are many overlapping identical shapes which are useless in some files, we can ingore them when loading files.
  - setIgnoreUselessShapes
```
public void setIgnoreUselessShapes(boolean value)
```
    Indicates whether ignoring useless shapes.
    Remarks
    Only works for xlsx,xlsb, and xlsm files. There are many overlapping identical shapes which are useless in some files, we can ingore them when loading files.
  - getPreservePaddingSpacesInFormula
```
public boolean getPreservePaddingSpacesInFormula()
```
    Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.
    Remarks
    After loading workbook from template file with this option, FormulaSettings.getPreservePaddingSpaces() will be set to the same value with this property.
  - setPreservePaddingSpacesInFormula
```
public void setPreservePaddingSpacesInFormula(boolean value)
```
    Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.
    Remarks
    After loading workbook from template file with this option, FormulaSettings.getPreservePaddingSpaces() will be set to the same value with this property.

Class LoadOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LoadOptions

LoadOptions

Method Detail

getLoadFormat

getPassword

setPassword

getParsingFormulaOnOpen

setParsingFormulaOnOpen

getParsingPivotCachedRecords

setParsingPivotCachedRecords

setPaperSize

getLanguageCode

setLanguageCode

getRegion

setRegion

getLocale

setLocale

getDefaultStyleSettings

getStandardFont

setStandardFont

getStandardFontSize

setStandardFontSize

getInterruptMonitor

setInterruptMonitor

getIgnoreNotPrinted

setIgnoreNotPrinted

getCheckDataValid

setCheckDataValid

getCheckExcelRestriction

setCheckExcelRestriction

getKeepUnparsedData

setKeepUnparsedData

getLoadFilter

setLoadFilter

getLightCellsDataHandler

setLightCellsDataHandler

getMemorySetting

setMemorySetting

getWarningCallback

setWarningCallback

getAutoFitterOptions

setAutoFitterOptions

getAutoFilter

setAutoFilter

getFontConfigs

setFontConfigs

getIgnoreUselessShapes

setIgnoreUselessShapes

getPreservePaddingSpacesInFormula

setPreservePaddingSpacesInFormula