Contains the options related to loading a workbook from a file or stream.

See

[[Workbook.load]]

Hierarchy

Hierarchy (view full)

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get autoResumeCalculations(): boolean
  • 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.

    See

    • [[Workbook.suspendCalculations]]
    • [[Workbook.resumeCalculations]]

    Returns boolean

  • set autoResumeCalculations(a): void
  • Parameters

    • a: boolean

    Returns void

  • get culture(): string | CultureInfo
  • Returns or sets the value for the [[Workbook.culture]] property.

    See

    [[Workbook.culture]]

    Returns string | CultureInfo

  • set culture(a): void
  • Parameters

    • a: string | CultureInfo

    Returns void

  • get isDuplicateFormulaParsingOptimized(): boolean
  • Returns or sets a boolean indicating whether duplicate formulas parsed during the load will be optimized for faster loading of the workbook.

    By default when an exact duplicate of a formula string is encountered during the load, the previously parsed formula will be cloned rather than reparsing the string to create an entirely new formula.

    Note: This property does not apply to the loading of the xls formats.

    Returns boolean

  • set isDuplicateFormulaParsingOptimized(a): void
  • Parameters

    • a: boolean

    Returns void

  • get screenDpi(): IgSize
  • Gets or sets the Dpi to use when calculating row and column sizes for the workbook. If empty, the system Dpi will be used.

    Throws

    [[ArgumentException]] Occurs when the specified value is not empty and does not have two positive values.

    Returns IgSize

  • set screenDpi(a): void
  • Parameters

    • a: IgSize

    Returns void

  • get userDefinedFunctions(): IList$1<ExcelCalcFunction>
  • Returns a list of user defined functions that should be registered before the workbook is loaded.

    Returns IList$1<ExcelCalcFunction>

Methods

  • Parameters

    • other: any

    Returns boolean

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns number

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Returns void