excel.interfaces.workbookloadoptions.yml

### YamlMime:TSType
name: Excel.Interfaces.WorkbookLoadOptions
uid: 'excel!Excel.Interfaces.WorkbookLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.WorkbookLoadOptions
summary: >-
  Workbook is the top level object which contains related workbook objects such as worksheets, tables, and ranges. To
  learn more about the workbook object model, read [Work with workbooks using the Excel JavaScript
  API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-workbooks)<!-- -->.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: $all
    uid: 'excel!Excel.Interfaces.WorkbookLoadOptions#$all:member'
    package: excel!
    fullName: $all
    summary: >-
      Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`<!-- -->) but not the
      navigational properties (e.g.: `Range.format.fill.color`<!-- -->).
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: '$all?: boolean;'
      return:
        type: boolean
  - name: application
    uid: 'excel!Excel.Interfaces.WorkbookLoadOptions#application:member'
    package: excel!
    fullName: application
    summary: Represents the Excel application instance that contains this workbook.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'application?: Excel.Interfaces.ApplicationLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ApplicationLoadOptions:interface" />'
  - name: autoSave
    uid: 'excel!Excel.Interfaces.WorkbookLoadOptions#autoSave:member'
    package: excel!
    fullName: autoSave
    summary: Specifies if the workbook is in AutoSave mode.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'autoSave?: boolean;'
      return:
        type: boolean
  - name: bindings
    uid: 'excel!Excel.Interfaces.WorkbookLoadOptions#bindings:member'
    package: excel!
    fullName: bindings
    summary: Represents a collection of bindings that are part of the workbook.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'bindings?: Excel.Interfaces.BindingCollectionLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.BindingCollectionLoadOptions:interface" />'
  - name: calculationEngineVersion
    uid: 'excel!Excel.Interfaces.WorkbookLoadOptions#calculationEngineVersion:member'
    package: excel!
    fullName: calculationEngineVersion
    summary: Returns a number about the version of Excel Calculation Engine.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'calculationEngineVersion?: boolean;'
      return:
        type: boolean
  - name: chartDataPointTrack
    uid: 'excel!Excel.Interfaces.WorkbookLoadOptions#chartDataPointTrack:member'
    package: excel!
    fullName: chartDataPointTrack
    summary: >-
      True if all charts in the workbook are tracking the actual data points to which they are attached. False if the
      charts track the index of the data points.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'chartDataPointTrack?: boolean;'
      return:
        type: boolean
  - name: isDirty
    uid: 'excel!Excel.Interfaces.WorkbookLoadOptions#isDirty:member'
    package: excel!
    fullName: isDirty
    summary: >-
      Specifies if changes have been made since the workbook was last saved. You can set this property to `true` if you
      want to close a modified workbook without either saving it or being prompted to save it.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'isDirty?: boolean;'
      return:
        type: boolean
  - name: name
    uid: 'excel!Excel.Interfaces.WorkbookLoadOptions#name:member'
    package: excel!
    fullName: name
    summary: Gets the workbook name.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'name?: boolean;'
      return:
        type: boolean
  - name: previouslySaved
    uid: 'excel!Excel.Interfaces.WorkbookLoadOptions#previouslySaved:member'
    package: excel!
    fullName: previouslySaved
    summary: Specifies if the workbook has ever been saved locally or online.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'previouslySaved?: boolean;'
      return:
        type: boolean
  - name: properties
    uid: 'excel!Excel.Interfaces.WorkbookLoadOptions#properties:member'
    package: excel!
    fullName: properties
    summary: Gets the workbook properties.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'properties?: Excel.Interfaces.DocumentPropertiesLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.DocumentPropertiesLoadOptions:interface" />'
  - name: protection
    uid: 'excel!Excel.Interfaces.WorkbookLoadOptions#protection:member'
    package: excel!
    fullName: protection
    summary: Returns the protection object for a workbook.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'protection?: Excel.Interfaces.WorkbookProtectionLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.WorkbookProtectionLoadOptions:interface" />'
  - name: readOnly
    uid: 'excel!Excel.Interfaces.WorkbookLoadOptions#readOnly:member'
    package: excel!
    fullName: readOnly
    summary: Returns `true` if the workbook is open in read-only mode.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readOnly?: boolean;'
      return:
        type: boolean
  - name: tables
    uid: 'excel!Excel.Interfaces.WorkbookLoadOptions#tables:member'
    package: excel!
    fullName: tables
    summary: Represents a collection of tables associated with the workbook.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'tables?: Excel.Interfaces.TableCollectionLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.TableCollectionLoadOptions:interface" />'
  - name: usePrecisionAsDisplayed
    uid: 'excel!Excel.Interfaces.WorkbookLoadOptions#usePrecisionAsDisplayed:member'
    package: excel!
    fullName: usePrecisionAsDisplayed
    summary: >-
      True if calculations in this workbook will be done using only the precision of the numbers as they're displayed.
      Data will permanently lose accuracy when switching this property from `false` to `true`<!-- -->.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'usePrecisionAsDisplayed?: boolean;'
      return:
        type: boolean