Excel.Interfaces.WorkbookLoadOptions interface

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.

Remarks

[ API set: ExcelApi 1.1 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

application

Represents the Excel application instance that contains this workbook.

autoSave

Specifies if the workbook is in AutoSave mode.

bindings

Represents a collection of bindings that are part of the workbook.

calculationEngineVersion

Returns a number about the version of Excel Calculation Engine.

chartDataPointTrack

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.

externalCodeServiceTimeout

Specifies the maximum length of time, in seconds, allotted for a formula that depends on an external code service to complete. The valid range is 1 to 86400, inclusive.

isDirty

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.

linkedWorkbooks

Returns a collection of linked workbooks. In formulas, the workbook links can be used to reference data (cell values and names) outside of the current workbook.

name

Gets the workbook name.

previouslySaved

Specifies if the workbook has ever been saved locally or online.

properties

Gets the workbook properties.

protection

Returns the protection object for a workbook.

readOnly

Returns true if the workbook is open in read-only mode.

showPivotFieldList

Specifies whether the PivotTable's field list pane is shown at the workbook level.

tables

Represents a collection of tables associated with the workbook.

use1904DateSystem

True if the workbook uses the 1904 date system.

usePrecisionAsDisplayed

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.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

application

Represents the Excel application instance that contains this workbook.

application?: Excel.Interfaces.ApplicationLoadOptions;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

autoSave

Specifies if the workbook is in AutoSave mode.

autoSave?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

bindings

Represents a collection of bindings that are part of the workbook.

bindings?: Excel.Interfaces.BindingCollectionLoadOptions;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

calculationEngineVersion

Returns a number about the version of Excel Calculation Engine.

calculationEngineVersion?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

chartDataPointTrack

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.

chartDataPointTrack?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

externalCodeServiceTimeout

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the maximum length of time, in seconds, allotted for a formula that depends on an external code service to complete. The valid range is 1 to 86400, inclusive.

externalCodeServiceTimeout?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

isDirty

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.

isDirty?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

linkedWorkbooks

Returns a collection of linked workbooks. In formulas, the workbook links can be used to reference data (cell values and names) outside of the current workbook.

linkedWorkbooks?: Excel.Interfaces.LinkedWorkbookCollectionLoadOptions;

Property Value

Remarks

[ API set: ExcelApiOnline 1.1 ]

name

Gets the workbook name.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

previouslySaved

Specifies if the workbook has ever been saved locally or online.

previouslySaved?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

properties

Gets the workbook properties.

properties?: Excel.Interfaces.DocumentPropertiesLoadOptions;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

protection

Returns the protection object for a workbook.

protection?: Excel.Interfaces.WorkbookProtectionLoadOptions;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

readOnly

Returns true if the workbook is open in read-only mode.

readOnly?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

showPivotFieldList

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies whether the PivotTable's field list pane is shown at the workbook level.

showPivotFieldList?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

tables

Represents a collection of tables associated with the workbook.

tables?: Excel.Interfaces.TableCollectionLoadOptions;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

use1904DateSystem

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

True if the workbook uses the 1904 date system.

use1904DateSystem?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

usePrecisionAsDisplayed

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.

usePrecisionAsDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]