Contains the options related to loading a workbook from a file or stream.
Constructors
Section titled "Constructors"WorkbookLoadOptions
new WorkbookLoadOptions(): WorkbookLoadOptions Returns WorkbookLoadOptions
Properties
Section titled "Properties"$t: Type Accessors
Section titled "Accessors"autoResumeCalculations
Section titled "autoResumeCalculations"Returns or sets a boolean indicating whether the Workbook will automatically call its [[Workbook.resumeCalculations]] methods before the Load method returns. When the Load method starts the [[Workbook.suspendCalculations]] is invoked so that no calculations occurs as the load is in progress. When the Load operation is complete and the Workbook is about to be returned from the Load method, it will call the [[Workbook.resumeCalculations]] method to ensure that the loaded formulas have been added to the calculation network and the formulas can be calculated. However if one wanted to delay calling that method, perhaps to add additional formulas to the workbook being loaded, one can set this property to false and then the Workbook will not call ResumeCalculations. Instead it will be the responsibility of the caller to invoke this method.
get autoResumeCalculations(): boolean
Returns boolean
set autoResumeCalculations(a: boolean): void Parameters
- a:
boolean
Returns void
culture
Section titled "culture"Returns or sets the value for the [[Workbook.culture]] property.
get culture(): any
Returns any
set culture(a: any): void Parameters
- a:
any
Returns void
isDuplicateFormulaParsingOptimized
Section titled "isDuplicateFormulaParsingOptimized"Returns or sets a boolean indicating whether duplicate formulas parsed during the load will be optimized for faster loading of the workbook.
get isDuplicateFormulaParsingOptimized(): boolean
Returns boolean
set isDuplicateFormulaParsingOptimized(a: boolean): void Parameters
- a:
boolean
Returns void
screenDpi
Section titled "screenDpi"Gets or sets the Dpi to use when calculating row and column sizes for the workbook. If empty, the system Dpi will be used.
get screenDpi(): IgSize
Returns IgSize
set screenDpi(a: IgSize): void Parameters
- a:
IgSize
Returns void
userDefinedFunctions
Section titled "userDefinedFunctions"Returns a list of user defined functions that should be registered before the workbook is loaded.
get userDefinedFunctions(): IList$1<ExcelCalcFunction>
Returns IList$1<ExcelCalcFunction>
Methods
Section titled "Methods"staticInit
Section titled "staticInit"Inherited from: WorkbookOptionsBase
staticInit(): void