ig.excel.WorkbookLoadOptions

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

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
  • ig.excel.WorkbookLoadOptions
    Constructor

    new $.ig.excel.WorkbookLoadOptions( );

    Creates a new WorkbookLoadOptions instance.

  • autoResumeCalculations

    .autoResumeCalculations( );

    Returns a boolean indicating whether the Workbook will automatically call its Workbook.resumeCalculations methods before the Load method returns.

    Remarks

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

    .autoResumeCalculations( value:boolean );

    Sets a boolean indicating whether the Workbook will automatically call its Workbook.resumeCalculations methods before the Load method returns.

    • value
    • Type:boolean

    Remarks

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

    .culture( );

    Returns the value for the Workbook.culture property.

  • culture

    .culture( value:string );

    Sets the value for the Workbook.culture property.

    • value
    • Type:string
  • isDuplicateFormulaParsingOptimized

    .isDuplicateFormulaParsingOptimized( );

    Returns a boolean indicating whether duplicate formulas parsed during the load will be optimized for faster loading of the workbook.

    Remarks

    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.

  • isDuplicateFormulaParsingOptimized

    .isDuplicateFormulaParsingOptimized( value:boolean );

    Sets a boolean indicating whether duplicate formulas parsed during the load will be optimized for faster loading of the workbook.

    • value
    • Type:boolean

    Remarks

    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.

  • userDefinedFunctions

    .userDefinedFunctions( );

    Returns a list of user defined functions that should be registered before the workbook is loaded.

Copyright © 1996 - 2019 Infragistics, Inc. All rights reserved.