Represents the options of loading the file. More...

Inherits Object.

Public Member Functions
virtual Aspose::Cells::LoadFormat	GetLoadFormat ()=0
	Gets the load format. More...

virtual intrusive_ptr< Aspose::Cells::Systems::String >	GetPassword ()=0
	Gets the password of the workbook. More...

virtual void	SetPassword (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
	Ssets the password of the workbook. More...

virtual bool	GetParsingFormulaOnOpen ()=0
	Indicates whether parsing the formula when reading the file. More...

virtual void	SetParsingFormulaOnOpen (bool value)=0
	Indicates whether parsing the formula when reading the file. More...

virtual bool	GetParsingPivotCachedRecords ()=0
	Indicates whether parsing pivot cached records when loading the file. The default value is false. More...

virtual void	SetParsingPivotCachedRecords (bool value)=0
	Indicates whether parsing pivot cached records when loading the file. The default value is false. More...

virtual void	SetPaperSize (Aspose::Cells::PaperSizeType type)=0
	Sets the default print paper size from default printer's setting. More...

virtual Aspose::Cells::CountryCode	GetLanguageCode ()=0
	Gets the user interface language of the Workbook version based on CountryCode that has saved the file. More...

virtual void	SetLanguageCode (Aspose::Cells::CountryCode value)=0
	Sets the user interface language of the Workbook version based on CountryCode that has saved the file. More...

virtual Aspose::Cells::CountryCode	GetRegion ()=0
	Gets the system regional settings based on CountryCode at the time the file was loaded. More...

virtual void	SetRegion (Aspose::Cells::CountryCode value)=0
	Sets the system regional settings based on CountryCode at the time the file was loaded. More...

virtual intrusive_ptr< Aspose::Cells::Systems::Globalization::CultureInfo >	GetCultureInfo ()=0
	Gets the system culture info at the time the file was loaded. More...

virtual void	SetCultureInfo (intrusive_ptr< Aspose::Cells::Systems::Globalization::CultureInfo > value)=0
	Sets the system culture info at the time the file was loaded. More...

virtual intrusive_ptr< Aspose::Cells::Systems::String >	GetStandardFont ()=0
	Gets the default standard font name More...

virtual void	SetStandardFont (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
	Sets the default standard font name More...

virtual Aspose::Cells::Systems::Double	GetStandardFontSize ()=0
	Sets the default standard font size. More...

virtual void	SetStandardFontSize (Aspose::Cells::Systems::Double value)=0
	Sets the default standard font size. More...

virtual bool	GetIgnoreNotPrinted ()=0
	Ignore the data which are not printed if directly printing the file More...

virtual void	SetIgnoreNotPrinted (bool value)=0
	Ignore the data which are not printed if directly printing the file More...

virtual bool	GetCheckDataValid ()=0
	Check whether data is valid in the template file. More...

virtual void	SetCheckDataValid (bool value)=0
	Check whether data is valid in the template file. More...

virtual bool	GetCheckExcelRestriction ()=0
	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. More...

virtual void	SetCheckExcelRestriction (bool value)=0
	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. More...

virtual bool	GetKeepUnparsedData ()=0
	Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true. More...

virtual void	SetKeepUnparsedData (bool value)=0
	Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true. More...

virtual intrusive_ptr< Aspose::Cells::ILoadFilter >	GetILoadFilter ()=0
	The filter to denote how to load data. More...

virtual void	SetILoadFilter (intrusive_ptr< Aspose::Cells::ILoadFilter > value)=0
	The filter to denote how to load data. More...

virtual Aspose::Cells::MemorySetting	GetMemorySetting ()=0
	Gets the memory usage options. More...

virtual void	SetMemorySetting (Aspose::Cells::MemorySetting value)=0
	Sets the memory usage options. More...

virtual intrusive_ptr< Aspose::Cells::IAutoFitterOptions >	GetIAutoFitterOptions ()=0
	Gets and sets the auto fitter options More...

virtual void	SetIAutoFitterOptions (intrusive_ptr< Aspose::Cells::IAutoFitterOptions > value)=0
	Sets the auto fitter options More...

virtual bool	GetAutoFilter ()=0
	Indicates whether auto filtering the data when loading the files. More...

virtual void	SetAutoFilter (bool value)=0
	Indicates whether auto filtering the data when loading the files. More...

virtual bool	GetIgnoreUselessShapes ()=0
	Indicates whether ignoring useless shapes. More...

virtual void	SetIgnoreUselessShapes (bool value)=0
	Indicates whether ignoring useless shapes. More...

virtual bool	GetPreservePaddingSpacesInFormula ()=0
	Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false. More...

virtual void	SetPreservePaddingSpacesInFormula (bool value)=0
	Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false. More...

Detailed Description

Represents the options of loading the file.

Member Function Documentation

◆ GetAutoFilter()

virtual bool Aspose::Cells::ILoadOptions::GetAutoFilter ( )

pure virtual

Indicates whether auto filtering the data when loading the files.

Sometimes although autofilter is set, the corresponding rows is not hidden in the file. Now only works for SpreadSheetML file.

◆ GetCheckDataValid()

virtual bool Aspose::Cells::ILoadOptions::GetCheckDataValid ( )

pure virtual

Check whether data is valid in the template file.

◆ GetCheckExcelRestriction()

virtual bool Aspose::Cells::ILoadOptions::GetCheckExcelRestriction ( )

pure virtual

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.

◆ GetCultureInfo()

virtual intrusive_ptr<Aspose::Cells::Systems::Globalization::CultureInfo> Aspose::Cells::ILoadOptions::GetCultureInfo ( )

pure virtual

Gets the system culture info at the time the file was loaded.

◆ GetIAutoFitterOptions()

virtual intrusive_ptr<Aspose::Cells::IAutoFitterOptions> Aspose::Cells::ILoadOptions::GetIAutoFitterOptions ( )

pure virtual

Gets and sets the auto fitter options

Only for xlsx ,spreadsheetML file now.

◆ GetIgnoreNotPrinted()

virtual bool Aspose::Cells::ILoadOptions::GetIgnoreNotPrinted ( )

pure virtual

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

Only for xlsx file.

◆ GetIgnoreUselessShapes()

virtual bool Aspose::Cells::ILoadOptions::GetIgnoreUselessShapes ( )

pure virtual

Indicates whether ignoring useless shapes.

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.

◆ GetILoadFilter()

virtual intrusive_ptr<Aspose::Cells::ILoadFilter> Aspose::Cells::ILoadOptions::GetILoadFilter ( )

pure virtual

The filter to denote how to load data.

◆ GetKeepUnparsedData()

virtual bool Aspose::Cells::ILoadOptions::GetKeepUnparsedData ( )

pure virtual

Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.

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,

◆ GetLanguageCode()

virtual Aspose::Cells::CountryCode Aspose::Cells::ILoadOptions::GetLanguageCode ( )

pure virtual

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

◆ GetLoadFormat()

virtual Aspose::Cells::LoadFormat Aspose::Cells::ILoadOptions::GetLoadFormat ( )

pure virtual

Gets the load format.

◆ GetMemorySetting()

virtual Aspose::Cells::MemorySetting Aspose::Cells::ILoadOptions::GetMemorySetting ( )

pure virtual

Gets the memory usage options.

◆ GetParsingFormulaOnOpen()

virtual bool Aspose::Cells::ILoadOptions::GetParsingFormulaOnOpen ( )

pure virtual

Indicates whether parsing the formula when reading the file.

Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file because the formulas in the files are stored with a string formula.

◆ GetParsingPivotCachedRecords()

virtual bool Aspose::Cells::ILoadOptions::GetParsingPivotCachedRecords ( )

pure virtual

Indicates whether parsing pivot cached records when loading the file. The default value is false.

Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file

◆ GetPassword()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::ILoadOptions::GetPassword ( )

pure virtual

Gets the password of the workbook.

◆ GetPreservePaddingSpacesInFormula()

virtual bool Aspose::Cells::ILoadOptions::GetPreservePaddingSpacesInFormula ( )

pure virtual

Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.

After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces

will be set to the same value with this property.

◆ GetRegion()

virtual Aspose::Cells::CountryCode Aspose::Cells::ILoadOptions::GetRegion ( )

pure virtual

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

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

◆ GetStandardFont()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::ILoadOptions::GetStandardFont ( )

pure virtual

Gets the default standard font name

◆ GetStandardFontSize()

virtual Aspose::Cells::Systems::Double Aspose::Cells::ILoadOptions::GetStandardFontSize ( )

pure virtual

Sets the default standard font size.

◆ SetAutoFilter()

virtual void Aspose::Cells::ILoadOptions::SetAutoFilter ( bool value )

pure virtual

Indicates whether auto filtering the data when loading the files.

Sometimes although autofilter is set, the corresponding rows is not hidden in the file. Now only works for SpreadSheetML file.

◆ SetCheckDataValid()

virtual void Aspose::Cells::ILoadOptions::SetCheckDataValid ( bool value )

pure virtual

Check whether data is valid in the template file.

◆ SetCheckExcelRestriction()

virtual void Aspose::Cells::ILoadOptions::SetCheckExcelRestriction ( bool value )

pure virtual

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.

◆ SetCultureInfo()

virtual void Aspose::Cells::ILoadOptions::SetCultureInfo ( intrusive_ptr< Aspose::Cells::Systems::Globalization::CultureInfo > value )

pure virtual

Sets the system culture info at the time the file was loaded.

◆ SetIAutoFitterOptions()

virtual void Aspose::Cells::ILoadOptions::SetIAutoFitterOptions ( intrusive_ptr< Aspose::Cells::IAutoFitterOptions > value )

pure virtual

Sets the auto fitter options

Only for xlsx ,spreadsheetML file now.

◆ SetIgnoreNotPrinted()

virtual void Aspose::Cells::ILoadOptions::SetIgnoreNotPrinted ( bool value )

pure virtual

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

Only for xlsx file.

◆ SetIgnoreUselessShapes()

virtual void Aspose::Cells::ILoadOptions::SetIgnoreUselessShapes ( bool value )

pure virtual

Indicates whether ignoring useless shapes.

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.

◆ SetILoadFilter()

virtual void Aspose::Cells::ILoadOptions::SetILoadFilter ( intrusive_ptr< Aspose::Cells::ILoadFilter > value )

pure virtual

The filter to denote how to load data.

◆ SetKeepUnparsedData()

virtual void Aspose::Cells::ILoadOptions::SetKeepUnparsedData ( bool value )

pure virtual

Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.

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,

◆ SetLanguageCode()

virtual void Aspose::Cells::ILoadOptions::SetLanguageCode ( Aspose::Cells::CountryCode value )

pure virtual

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

◆ SetMemorySetting()

virtual void Aspose::Cells::ILoadOptions::SetMemorySetting ( Aspose::Cells::MemorySetting value )

pure virtual

Sets the memory usage options.

◆ SetPaperSize()

virtual void Aspose::Cells::ILoadOptions::SetPaperSize ( Aspose::Cells::PaperSizeType type )

pure virtual

Sets the default print paper size from default printer's setting.

Parameters

type	The default paper size.

If there is no setting about paper size,MS Excel will use default printer's setting.

◆ SetParsingFormulaOnOpen()

virtual void Aspose::Cells::ILoadOptions::SetParsingFormulaOnOpen ( bool value )

pure virtual

Indicates whether parsing the formula when reading the file.

Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file because the formulas in the files are stored with a string formula.

◆ SetParsingPivotCachedRecords()

virtual void Aspose::Cells::ILoadOptions::SetParsingPivotCachedRecords ( bool value )

pure virtual

Indicates whether parsing pivot cached records when loading the file. The default value is false.

Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file

◆ SetPassword()

virtual void Aspose::Cells::ILoadOptions::SetPassword ( intrusive_ptr< Aspose::Cells::Systems::String > value )

pure virtual

Ssets the password of the workbook.

◆ SetPreservePaddingSpacesInFormula()

virtual void Aspose::Cells::ILoadOptions::SetPreservePaddingSpacesInFormula ( bool value )

pure virtual

Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.

After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces

will be set to the same value with this property.

◆ SetRegion()

virtual void Aspose::Cells::ILoadOptions::SetRegion ( Aspose::Cells::CountryCode value )

pure virtual

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

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

◆ SetStandardFont()

virtual void Aspose::Cells::ILoadOptions::SetStandardFont ( intrusive_ptr< Aspose::Cells::Systems::String > value )

pure virtual

Sets the default standard font name

◆ SetStandardFontSize()

virtual void Aspose::Cells::ILoadOptions::SetStandardFontSize ( Aspose::Cells::Systems::Double value )

pure virtual

Sets the default standard font size.

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetAutoFilter()

◆ GetCheckDataValid()

◆ GetCheckExcelRestriction()

◆ GetCultureInfo()

◆ GetIAutoFitterOptions()

◆ GetIgnoreNotPrinted()

◆ GetIgnoreUselessShapes()

◆ GetILoadFilter()

◆ GetKeepUnparsedData()

◆ GetLanguageCode()

◆ GetLoadFormat()

◆ GetMemorySetting()

◆ GetParsingFormulaOnOpen()

◆ GetParsingPivotCachedRecords()

◆ GetPassword()

◆ GetPreservePaddingSpacesInFormula()

◆ GetRegion()

◆ GetStandardFont()

◆ GetStandardFontSize()

◆ SetAutoFilter()

◆ SetCheckDataValid()

◆ SetCheckExcelRestriction()

◆ SetCultureInfo()

◆ SetIAutoFitterOptions()

◆ SetIgnoreNotPrinted()

◆ SetIgnoreUselessShapes()

◆ SetILoadFilter()

◆ SetKeepUnparsedData()

◆ SetLanguageCode()

◆ SetMemorySetting()

◆ SetPaperSize()

◆ SetParsingFormulaOnOpen()

◆ SetParsingPivotCachedRecords()

◆ SetPassword()

◆ SetPreservePaddingSpacesInFormula()

◆ SetRegion()

◆ SetStandardFont()

◆ SetStandardFontSize()