aspose.cells

Constructor Detail

• XmlLoadOptions

  function XmlLoadOptions()

  Represents the options of loading xml file.

• XmlLoadOptions

  function XmlLoadOptions(type)

  Represents the options of loading xml file.

  Parameters:

  type: Number - A LoadFormat value. The load format type.

Property Getters/Setters Detail

• getStartCell/setStartCell : String 

  function getStartCell() / function setStartCell(value)
  

  Gets and sets the start cell.

  Only works when the file is not speadsheetML or mapping xml to Excel.

• isXmlMap/setXmlMap : boolean 

  function isXmlMap() / function setXmlMap(value)
  

  Indicates whether mapping xml to Excel. The default value is false.

• containsMultipleWorksheets/setContainsMultipleWorksheets : boolean 

  function containsMultipleWorksheets() / function setContainsMultipleWorksheets(value)
  

  Indicates whether importing xml as multiple worksheets.

• getConvertNumericOrDate/setConvertNumericOrDate : boolean 

  function getConvertNumericOrDate() / function setConvertNumericOrDate(value)
  

  Indicates whether converting the value in xml file to numeric or date.

• getNumberFormat/setNumberFormat : String 

  function getNumberFormat() / function setNumberFormat(value)
  

  Gets and sets the format of numeric value.

• getDateFormat/setDateFormat : String 

  function getDateFormat() / function setDateFormat(value)
  

  Gets and sets the format of date value.

• getIgnoreRootAttributes/setIgnoreRootAttributes : boolean 

  function getIgnoreRootAttributes() / function setIgnoreRootAttributes(value)
  

  Indicates whether ignore attributes of the root element.

• 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.

• getDefaultStyleSettings : DefaultStyleSettings 

  function getDefaultStyleSettings()
  

  Gets the default style settings for initializing styles of the workbook

• getStandardFont/setStandardFont : String 

  function getStandardFont() / function setStandardFont(value)
  

  Sets the default standard font name

  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.

• getStandardFontSize/setStandardFontSize : Number 

  function getStandardFontSize() / function setStandardFontSize(value)
  

  Sets the default standard font size.

  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.

• getInterruptMonitor/setInterruptMonitor : AbstractInterruptMonitor 

  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.

• getWarningCallback/setWarningCallback : IWarningCallback 

  function getWarningCallback() / function setWarningCallback(value)
  

  Gets or sets warning callback.

• getAutoFitterOptions/setAutoFitterOptions : AutoFitterOptions 

  function getAutoFitterOptions() / function setAutoFitterOptions(value)
  

  Gets and sets the auto fitter options

  Only for xlsx ,spreadsheetML 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.

• getIgnoreUselessShapes/setIgnoreUselessShapes : boolean 

  function getIgnoreUselessShapes() / function setIgnoreUselessShapes(value)
  

  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.

• getPreservePaddingSpacesInFormula/setPreservePaddingSpacesInFormula : boolean 

  function getPreservePaddingSpacesInFormula() / function setPreservePaddingSpacesInFormula(value)
  

  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.

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.