asposecells.api
Class OdsLoadOptions

Represents the options of loading ods file.

Constructor Summary
OdsLoadOptions()
           Represents the options of loading ods file.
OdsLoadOptions(type)
           Represents the options of loading ods file.
 
Property Getters/Setters Summary
methodgetApplyExcelDefaultStyleToHyperlink()
methodsetApplyExcelDefaultStyleToHyperlink(value)
           Indicates whether applying the default style of the Excel to hyperlink.
methodgetAutoFitterOptions()
methodsetAutoFitterOptions(value)
           Gets and sets the auto fitter options
methodgetCheckExcelRestriction()
methodsetCheckExcelRestriction(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.
methodgetFontConfigs()
methodsetFontConfigs(value)
           Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.>
methodgetIgnoreNotPrinted()
methodsetIgnoreNotPrinted(value)
           Ignore the data which are not printed if directly printing the file
methodgetInterruptMonitor()
methodsetInterruptMonitor(value)
           Gets and sets the interrupt monitor.
methodgetKeepUnparsedData()
methodsetKeepUnparsedData(value)
           Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
methodgetLanguageCode()
methodsetLanguageCode(value)
           Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. The value of the property is CountryCode integer constant.
methodgetLightCellsDataHandler()
methodsetLightCellsDataHandler(value)
           The data handler for processing cells data when reading template file.
methodgetLoadFilter()
methodsetLoadFilter(value)
           The filter to denote how to load data.
methodgetLoadFormat()
           Gets the load format. The value of the property is LoadFormat integer constant.
methodgetLocale()
methodsetLocale(value)
           Gets and sets the Locale used for workbook at the time the file was loaded.
methodgetMemorySetting()
methodsetMemorySetting(value)
           Gets or sets the memory usage options. The value of the property is MemorySetting integer constant.
methodgetParsingFormulaOnOpen()
methodsetParsingFormulaOnOpen(value)
           Indicates whether parsing the formula when reading the file.
methodgetParsingPivotCachedRecords()
methodsetParsingPivotCachedRecords(value)
           Inidicates whether parsing pivot cached records when loadiing the file. The default value is false.
methodgetPassword()
methodsetPassword(value)
           Gets and set the password of the workbook.
methodgetRegion()
methodsetRegion(value)
           Gets or sets the system regional settings based on CountryCode at the time the file was loaded. The value of the property is CountryCode integer constant.
methodgetStandardFont()
methodsetStandardFont(value)
           Sets the default standard font name
methodgetStandardFontSize()
methodsetStandardFontSize(value)
           Sets the default standard font size.
methodgetWarningCallback()
methodsetWarningCallback(value)
           Gets or sets warning callback.
 
Method Summary
methodsetPaperSize(type)→ inherited from LoadOptions
           Sets the default print paper size from default printer's setting.
 

Constructor Detail

OdsLoadOptions

OdsLoadOptions()
Represents the options of loading ods file.

OdsLoadOptions

OdsLoadOptions(type)
Represents the options of loading ods file.
Parameters:
type: int - A LoadFormat value. The load format type.

Property Getters/Setters Detail

getApplyExcelDefaultStyleToHyperlink/setApplyExcelDefaultStyleToHyperlink : boolean 

boolean getApplyExcelDefaultStyleToHyperlink() / setApplyExcelDefaultStyleToHyperlink(value)
Indicates whether applying the default style of the Excel to hyperlink.

getLoadFormat : int 

int getLoadFormat()
Gets the load format. The value of the property is LoadFormat integer constant.

getPassword/setPassword : String 

String getPassword() / setPassword(value)
Gets and set the password of the workbook.

getParsingFormulaOnOpen/setParsingFormulaOnOpen : boolean 

boolean getParsingFormulaOnOpen() / setParsingFormulaOnOpen(value)
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/setParsingPivotCachedRecords : boolean 

boolean getParsingPivotCachedRecords() / setParsingPivotCachedRecords(value)
Inidicates whether parsing pivot cached records when loadiing the file. The default value is false. Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file

getLanguageCode/setLanguageCode : int 

int getLanguageCode() / setLanguageCode(value)
Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. The value of the property is CountryCode integer constant.

getRegion/setRegion : int 

int getRegion() / setRegion(value)
Gets or sets the system regional settings based on CountryCode at the time the file was loaded. The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file, please reset it after reading the file.

getLocale/setLocale : Locale 

Locale getLocale() / setLocale(value)
Gets and sets the Locale used for workbook at the time the file was loaded.

getStandardFont/setStandardFont : String 

String getStandardFont() / setStandardFont(value)
Sets the default standard font name

getStandardFontSize/setStandardFontSize : float 

float getStandardFontSize() / setStandardFontSize(value)
Sets the default standard font size.

getInterruptMonitor/setInterruptMonitor : InterruptMonitor 

InterruptMonitor getInterruptMonitor() / setInterruptMonitor(value)
Gets and sets the interrupt monitor.

getIgnoreNotPrinted/setIgnoreNotPrinted : boolean 

boolean getIgnoreNotPrinted() / setIgnoreNotPrinted(value)
Ignore the data which are not printed if directly printing the file Only for xlsx file.

getCheckExcelRestriction/setCheckExcelRestriction : boolean 

boolean getCheckExcelRestriction() / setCheckExcelRestriction(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/setKeepUnparsedData : boolean 

boolean getKeepUnparsedData() / setKeepUnparsedData(value)
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,

getLoadFilter/setLoadFilter : LoadFilter 

LoadFilter getLoadFilter() / setLoadFilter(value)
The filter to denote how to load data.

getLightCellsDataHandler/setLightCellsDataHandler : LightCellsDataHandler 

LightCellsDataHandler getLightCellsDataHandler() / setLightCellsDataHandler(value)
The data handler for processing cells data when reading template file.

getMemorySetting/setMemorySetting : int 

int getMemorySetting() / setMemorySetting(value)
Gets or sets the memory usage options. The value of the property is MemorySetting integer constant.

getWarningCallback/setWarningCallback : IWarningCallback 

IWarningCallback getWarningCallback() / setWarningCallback(value)
Gets or sets warning callback.

getAutoFitterOptions/setAutoFitterOptions : AutoFitterOptions 

AutoFitterOptions getAutoFitterOptions() / setAutoFitterOptions(value)
Gets and sets the auto fitter options Only for xlsx file now.

getFontConfigs/setFontConfigs : IndividualFontConfigs 

IndividualFontConfigs getFontConfigs() / setFontConfigs(value)
Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.>

Method Detail

setPaperSize

 setPaperSize(type)
Sets the default print paper size from default printer's setting. If there is no setting about paper size,MS Excel will use default printer's setting.
Parameters:
type: int - A PaperSizeType value. The default paper size.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.