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
functiongetAutoFitterOptions()
functionsetAutoFitterOptions(value)
           Gets and sets the auto fitter options
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.
functiongetConvertNumericData()
functionsetConvertNumericData(value)
           Gets or sets a value that indicates whether the string in text file is converted to numeric data.
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.
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.
functiongetLoadDataAndFormatting()
functionsetLoadDataAndFormatting(value)
           If true, only loads data , formulas and formatting from the file, other contents and settings are all discarded. For example : shapes ,validation,conditional formatting,pivotables are not loaded.
functiongetLoadDataFilterOptions()
functionsetLoadDataFilterOptions(value)
           The filter options to denote what data should be loaded. The value of the property is LoadDataFilterOptions integer constant.
functiongetLoadDataOnly()
functionsetLoadDataOnly(value)
           If true, only loads data and formulas from the file, other contents and settings are all discarded.
functiongetLoadDataOptions()
functionsetLoadDataOptions(value)
           Only effects when OnlyLoadData is true.
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.
functiongetOnlyLoadDocumentProperties()
functionsetOnlyLoadDocumentProperties(value)
           If true, only loads document properties
functiongetParsingFormulaOnOpen()
functionsetParsingFormulaOnOpen(value)
           Indicates whether parsing the formula when reading the file.
functiongetParsingPivotCachedRecords()
functionsetParsingPivotCachedRecords(value)
           Inidicates whether parsing pivot cached records when loadiing 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)
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

getLoadDataAndFormatting/setLoadDataAndFormatting : boolean 

function getLoadDataAndFormatting() / function setLoadDataAndFormatting(value)
If true, only loads data , formulas and formatting from the file, other contents and settings are all discarded. For example : shapes ,validation,conditional formatting,pivotables are not loaded. NOTE: This member is now obsolete. Instead, please use LoadFilter property(LoadFilter = new LoadFilter(LoadDataFilterOptions.CellData). This property will be removed 12 months later since November 2016. Aspose apologizes for any inconvenience you may have experienced.

getLoadDataOnly/setLoadDataOnly : boolean 

function getLoadDataOnly() / function setLoadDataOnly(value)
If true, only loads data and formulas from the file, other contents and settings are all discarded. NOTE: This member is now obsolete. Instead, please use LoadFilter property(LoadFilter = new LoadFilter(LoadDataFilterOptions.CellData). This property will be removed 12 months later since June 2016. Aspose apologizes for any inconvenience you may have experienced.

getOnlyLoadDocumentProperties/setOnlyLoadDocumentProperties : boolean 

function getOnlyLoadDocumentProperties() / function setOnlyLoadDocumentProperties(value)
If true, only loads document properties Only for excel 97- 2003 xls file. If the file is encrypted, we still can get the document properties without password NOTE: This member is now obsolete. Instead, please use LoadFilter property(LoadFilter = new LoadFilter(LoadDataFilterOptions.DocumentProperties). This property will be removed 12 months later since November 2016. Aspose apologizes for any inconvenience you may have experienced.

getLoadDataOptions/setLoadDataOptions : LoadDataOption 

function getLoadDataOptions() / function setLoadDataOptions(value)
Only effects when OnlyLoadData is true. NOTE: This member is now obsolete. Instead, please use LoadFilter property(User may extend LoadFilter to filter the worksheet and data). This property will be removed 12 months later since November 2016. Aspose apologizes for any inconvenience you may have experienced.

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.

getConvertNumericData/setConvertNumericData : boolean 

function getConvertNumericData() / function setConvertNumericData(value)
Gets or sets a value that indicates whether the string in text file is converted to numeric data. NOTE: This member is now obsolete. Instead, please use HTMLLoadOptions.ConvertNumericData or HTMLLoadOptions.ConvertDateTimeData property. This property will be removed 12 months later since April 2016. Aspose apologizes for any inconvenience you may have experienced.

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.

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.

getLoadFilter/setLoadFilter : LoadFilter 

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

getLoadDataFilterOptions/setLoadDataFilterOptions : Number 

function getLoadDataFilterOptions() / function setLoadDataFilterOptions(value)
The filter options to denote what data should be loaded. The value of the property is LoadDataFilterOptions integer constant. NOTE: This member is now obsolete. Instead, please use LoadFilter property(LoadFilter = new LoadFilter(LoadDataFilterOptions). This property will be removed 12 months later since November 2016. Aspose apologizes for any inconvenience you may have experienced.

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.

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.