LoadOptions

Inheritance: java.lang.Object

public class LoadOptions

Represents the options of loading the file.

Constructors

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

Methods

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

LoadOptions()

public LoadOptions()

Creates an options of loading the file.

LoadOptions(int loadFormat)

public LoadOptions(int loadFormat)

Creates an options of loading the file.

Parameters:

Parameter	Type	Description
loadFormat	int	LoadFormat. The loading format.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

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.

Returns: boolean

getAutoFitterOptions()

public AutoFitterOptions getAutoFitterOptions()

Gets the auto fitter options

Remarks

Only for xlsx ,spreadsheetML file now.

Returns: AutoFitterOptions

getCheckDataValid()

public boolean getCheckDataValid()

Check whether data is valid in the template file.

Returns: boolean

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.

Returns: boolean

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getDefaultStyleSettings()

public DefaultStyleSettings getDefaultStyleSettings()

Gets the default style settings for initializing styles of the workbook

Returns: DefaultStyleSettings

getFontConfigs()

public IndividualFontConfigs getFontConfigs()

Gets individual font configs. Only works for the Workbook which uses this LoadOptions to load.

Returns: IndividualFontConfigs

getIgnoreNotPrinted()

public boolean getIgnoreNotPrinted()

Ignore the data which are not printed if directly printing the file

Remarks

Only for xlsx file.

Returns: boolean

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.

Returns: boolean

getInterruptMonitor()

public AbstractInterruptMonitor getInterruptMonitor()

Gets the interrupt monitor.

Returns: AbstractInterruptMonitor

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,

Returns: boolean

getLanguageCode()

public int getLanguageCode()

Gets the user interface language of the Workbook version based on CountryCode that has saved the file.

See CountryCode.

Returns: int

getLightCellsDataHandler()

public LightCellsDataHandler getLightCellsDataHandler()

The data handler for processing cells data when reading template file.

Returns: LightCellsDataHandler

getLoadFilter()

public LoadFilter getLoadFilter()

The filter to denote how to load data.

Returns: LoadFilter

getLoadFormat()

public int getLoadFormat()

Gets the load format.

See LoadFormat.

Returns: int

getLocale()

public Locale getLocale()

Gets the Locale used for workbook at the time the file was loaded.

Remarks

Returns: java.util.Locale

getMemorySetting()

public int getMemorySetting()

Gets the memory usage options.

See MemorySetting.

Returns: int

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.

Returns: boolean

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

Returns: boolean

getPassword()

public String getPassword()

Gets the password of the workbook.

Returns: java.lang.String

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.

Returns: boolean

getRegion()

public int getRegion()

Gets the system regional settings based on CountryCode at the time the file was loaded.

See CountryCode.

Remarks

If you do not want to use the region saved in the file, please reset it after reading the file.

Returns: int

getStandardFont()

public String getStandardFont()

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.

Returns: java.lang.String

getStandardFontSize()

public double getStandardFontSize()

Sets the default standard font size.

Remarks

Returns: double

getWarningCallback()

public IWarningCallback getWarningCallback()

Gets warning callback.

Returns: IWarningCallback

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setAutoFilter(boolean value)

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.

Parameters:

Parameter	Type	Description
value	boolean

setAutoFitterOptions(AutoFitterOptions value)

public void setAutoFitterOptions(AutoFitterOptions value)

Sets the auto fitter options

Remarks

Only for xlsx ,spreadsheetML file now.

Parameters:

Parameter	Type	Description
value	AutoFitterOptions

setCheckDataValid(boolean value)

public void setCheckDataValid(boolean value)

Check whether data is valid in the template file.

Parameters:

Parameter	Type	Description
value	boolean

setCheckExcelRestriction(boolean value)

public void setCheckExcelRestriction(boolean value)

Parameters:

Parameter	Type	Description
value	boolean

setFontConfigs(IndividualFontConfigs value)

public void setFontConfigs(IndividualFontConfigs value)

Sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.

Parameters:

Parameter	Type	Description
value	IndividualFontConfigs

setIgnoreNotPrinted(boolean value)

public void setIgnoreNotPrinted(boolean value)

Ignore the data which are not printed if directly printing the file

Remarks

Only for xlsx file.

Parameters:

Parameter	Type	Description
value	boolean

setIgnoreUselessShapes(boolean value)

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.

Parameters:

Parameter	Type	Description
value	boolean

setInterruptMonitor(AbstractInterruptMonitor value)

public void setInterruptMonitor(AbstractInterruptMonitor value)

Sets the interrupt monitor.

Parameters:

Parameter	Type	Description
value	AbstractInterruptMonitor

setKeepUnparsedData(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setLanguageCode(int value)

public void setLanguageCode(int value)

Sets the user interface language of the Workbook version based on CountryCode that has saved the file.

See CountryCode.

Parameters:

Parameter	Type	Description
value	int

setLightCellsDataHandler(LightCellsDataHandler value)

public void setLightCellsDataHandler(LightCellsDataHandler value)

The data handler for processing cells data when reading template file.

Parameters:

Parameter	Type	Description
value	LightCellsDataHandler

setLoadFilter(LoadFilter value)

public void setLoadFilter(LoadFilter value)

The filter to denote how to load data.

Parameters:

Parameter	Type	Description
value	LoadFilter

setLocale(Locale value)

public void setLocale(Locale value)

Sets the Locale used for workbook at the time the file was loaded.

Remarks

Parameters:

Parameter	Type	Description
value	java.util.Locale

setMemorySetting(int value)

public void setMemorySetting(int value)

Sets the memory usage options.

See MemorySetting.

Parameters:

Parameter	Type	Description
value	int

setPaperSize(int type)

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:

Parameter	Type	Description
type	int	PaperSizeType. The default paper size.

setParsingFormulaOnOpen(boolean value)

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.

Parameters:

Parameter	Type	Description
value	boolean

setParsingPivotCachedRecords(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setPassword(String value)

public void setPassword(String value)

Sets the password of the workbook.

Parameters:

Parameter	Type	Description
value	java.lang.String

setPreservePaddingSpacesInFormula(boolean value)

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.

Parameters:

Parameter	Type	Description
value	boolean

setRegion(int value)

public void setRegion(int value)

Sets the system regional settings based on CountryCode at the time the file was loaded.

See CountryCode.

Remarks

If you do not want to use the region saved in the file, please reset it after reading the file.

Parameters:

Parameter	Type	Description
value	int

setStandardFont(String value)

public void setStandardFont(String value)

Sets the default standard font name

Remarks

Parameters:

Parameter	Type	Description
value	java.lang.String

setStandardFontSize(double value)

public void setStandardFontSize(double value)

Sets the default standard font size.

Remarks

Parameters:

Parameter	Type	Description
value	double

setWarningCallback(IWarningCallback value)

public void setWarningCallback(IWarningCallback value)

Sets warning callback.

Parameters:

Parameter	Type	Description
value	IWarningCallback

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int