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
Properties
| $all | Specifying |
| application | Represents the Excel application instance that contains this workbook. |
| auto |
Specifies if the workbook is in AutoSave mode. |
| bindings | Represents a collection of bindings that are part of the workbook. |
| calculation |
Returns a number about the version of Excel Calculation Engine. |
| chart |
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. |
| external |
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. |
| is |
Specifies if changes have been made since the workbook was last saved. You can set this property to |
| linked |
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. |
| previously |
Specifies if the workbook has ever been saved locally or online. |
| properties | Gets the workbook properties. |
| protection | Returns the protection object for a workbook. |
| read |
Returns |
| show |
Specifies whether the PivotTable's field list pane is shown at the workbook level. |
| tables | Represents a collection of tables associated with the workbook. |
| use1904Date |
True if the workbook uses the 1904 date system. |
| use |
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 |
Property Details
$all
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).
$all?: boolean;Property Value
boolean
application
Represents the Excel application instance that contains this workbook.
application?: Excel.Interfaces.ApplicationLoadOptions;Property Value
Remarks
autoSave
Specifies if the workbook is in AutoSave mode.
autoSave?: boolean;Property Value
boolean
Remarks
bindings
Represents a collection of bindings that are part of the workbook.
bindings?: Excel.Interfaces.BindingCollectionLoadOptions;Property Value
Remarks
calculationEngineVersion
Returns a number about the version of Excel Calculation Engine.
calculationEngineVersion?: boolean;Property Value
boolean
Remarks
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
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
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
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
name
previouslySaved
Specifies if the workbook has ever been saved locally or online.
previouslySaved?: boolean;Property Value
boolean
Remarks
properties
Gets the workbook properties.
properties?: Excel.Interfaces.DocumentPropertiesLoadOptions;Property Value
Remarks
protection
Returns the protection object for a workbook.
protection?: Excel.Interfaces.WorkbookProtectionLoadOptions;Property Value
Remarks
readOnly
Returns true if the workbook is open in read-only mode.
readOnly?: boolean;Property Value
boolean
Remarks
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
tables
Represents a collection of tables associated with the workbook.
tables?: Excel.Interfaces.TableCollectionLoadOptions;Property Value
Remarks
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
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
Office Add-ins
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for