aspose.cells
Class LoadOptions

Represents the options of loading the file.

Constructor Summary
LoadOptions()
           Creates an options of loading the file.
LoadOptions(loadFormat)
           Creates an options of loading the file.
 
Property Getters/Setters Summary
functiongetAutoFilter()
functionsetAutoFilter(value)
           Indicates whether auto filtering the data when loading the files.
functiongetAutoFitterOptions()
functionsetAutoFitterOptions(value)
           Gets and sets the auto fitter options
functiongetCheckDataValid()
functionsetCheckDataValid(value)
           Check whether data is valid in the template file.
functiongetCheckExcelRestriction()
functionsetCheckExcelRestriction(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.
functiongetFontConfigs()
functionsetFontConfigs(value)
           Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.>
functiongetIgnoreNotPrinted()
functionsetIgnoreNotPrinted(value)
           Ignore the data which are not printed if directly printing the file
functiongetInterruptMonitor()
functionsetInterruptMonitor(value)
           Gets and sets the interrupt monitor.
functiongetKeepUnparsedData()
functionsetKeepUnparsedData(value)
           Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
functiongetLanguageCode()
functionsetLanguageCode(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.
functiongetLightCellsDataHandler()
functionsetLightCellsDataHandler(value)
           The data handler for processing cells data when reading template file.
functiongetLoadFilter()
functionsetLoadFilter(value)
           The filter to denote how to load data.
functiongetLoadFormat()
           Gets the load format. The value of the property is LoadFormat integer constant.
functiongetLocale()
functionsetLocale(value)
           Gets and sets the Locale used for workbook at the time the file was loaded.
functiongetMemorySetting()
functionsetMemorySetting(value)
           Gets or sets the memory usage options. The value of the property is MemorySetting integer constant.
functiongetParsingFormulaOnOpen()
functionsetParsingFormulaOnOpen(value)
           Indicates whether parsing the formula when reading the file.
functiongetParsingPivotCachedRecords()
functionsetParsingPivotCachedRecords(value)
           Indicates whether parsing pivot cached records when loading the file. The default value is false.
functiongetPassword()
functionsetPassword(value)
           Gets and set the password of the workbook.
functiongetRegion()
functionsetRegion(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.
functiongetStandardFont()
functionsetStandardFont(value)
           Sets the default standard font name
functiongetStandardFontSize()
functionsetStandardFontSize(value)
           Sets the default standard font size.
 
Method Summary
functionsetPaperSize(type)
           Sets the default print paper size from default printer's setting.
 

Constructor Detail

LoadOptions

function LoadOptions()
Creates an options of loading the file.

LoadOptions

function LoadOptions(loadFormat)
Creates an options of loading the file.
Parameters:
loadFormat: Number - A LoadFormat value. The loading format.

Property Getters/Setters Detail

getLoadFormat : Number 

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

getPassword/setPassword : String 

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

getParsingFormulaOnOpen/setParsingFormulaOnOpen : boolean 

function getParsingFormulaOnOpen() / function 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 

function getParsingPivotCachedRecords() / function setParsingPivotCachedRecords(value)
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

getLanguageCode/setLanguageCode : Number 

function getLanguageCode() / function 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 : Number 

function getRegion() / function 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 

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

getStandardFont/setStandardFont : String 

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

getStandardFontSize/setStandardFontSize : Number 

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

getInterruptMonitor/setInterruptMonitor : InterruptMonitor 

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

getIgnoreNotPrinted/setIgnoreNotPrinted : boolean 

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

getCheckDataValid/setCheckDataValid : boolean 

function getCheckDataValid() / function setCheckDataValid(value)
Check whether data is valid in the template file.

getCheckExcelRestriction/setCheckExcelRestriction : boolean 

function getCheckExcelRestriction() / function 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 

function getKeepUnparsedData() / function 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 

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

getLightCellsDataHandler/setLightCellsDataHandler : LightCellsDataHandler 

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

getMemorySetting/setMemorySetting : Number 

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

getAutoFitterOptions/setAutoFitterOptions : AutoFitterOptions 

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

getAutoFilter/setAutoFilter : boolean 

function getAutoFilter() / function setAutoFilter(value)
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.

getFontConfigs/setFontConfigs : IndividualFontConfigs 

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

Method Detail

setPaperSize

function 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: Number - 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.