Excel.Interfaces.WorkbookData interface
An interface describing the data returned by calling workbook.toJSON().
| 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. |
| comments | Represents a collection of comments associated with the workbook. |
| custom |
Represents the collection of custom XML parts contained by this workbook. |
| 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 |
| name | Gets the workbook name. |
| names | Represents a collection of workbook-scoped named items (named ranges and constants). |
| notes | Returns a collection of all the notes objects in the workbook. |
| pivot |
Represents a collection of PivotTables associated with the workbook. |
| pivot |
Represents a collection of PivotTableStyles associated with the workbook. |
| 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 |
| settings | Represents a collection of settings associated with the workbook. |
| show |
Specifies whether the PivotTable's field list pane is shown at the workbook level. |
| slicers | Represents a collection of slicers associated with the workbook. |
| slicer |
Represents a collection of SlicerStyles associated with the workbook. |
| styles | Represents a collection of styles associated with the workbook. |
| tables | Represents a collection of tables associated with the workbook. |
| table |
Represents a collection of TableStyles associated with the workbook. |
| timeline |
Represents a collection of TimelineStyles 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 |
| worksheets | Represents a collection of worksheets associated with the workbook. |
Specifies if the workbook is in AutoSave mode.
autoSave?: boolean;Property Value
boolean
Remarks
Represents a collection of bindings that are part of the workbook.
bindings?: Excel.Interfaces.BindingData[];Property Value
Remarks
Returns a number about the version of Excel Calculation Engine.
calculationEngineVersion?: number;Property Value
number
Remarks
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
Represents a collection of comments associated with the workbook.
comments?: Excel.Interfaces.CommentData[];Property Value
Remarks
Represents the collection of custom XML parts contained by this workbook.
customXmlParts?: Excel.Interfaces.CustomXmlPartData[];Property Value
Remarks
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?: number;Property Value
number
Remarks
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
Gets the workbook name.
name?: string;Property Value
string
Remarks
Represents a collection of workbook-scoped named items (named ranges and constants).
names?: Excel.Interfaces.NamedItemData[];Property Value
Remarks
Returns a collection of all the notes objects in the workbook.
notes?: Excel.Interfaces.NoteData[];Property Value
Remarks
Represents a collection of PivotTables associated with the workbook.
pivotTables?: Excel.Interfaces.PivotTableData[];Property Value
Remarks
Represents a collection of PivotTableStyles associated with the workbook.
pivotTableStyles?: Excel.Interfaces.PivotTableStyleData[];Property Value
Remarks
Specifies if the workbook has ever been saved locally or online.
previouslySaved?: boolean;Property Value
boolean
Remarks
Gets the workbook properties.
properties?: Excel.Interfaces.DocumentPropertiesData;Property Value
Remarks
Returns the protection object for a workbook.
protection?: Excel.Interfaces.WorkbookProtectionData;Property Value
Remarks
Returns true if the workbook is open in read-only mode.
readOnly?: boolean;Property Value
boolean
Remarks
Represents a collection of settings associated with the workbook.
settings?: Excel.Interfaces.SettingData[];Property Value
Remarks
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
Represents a collection of slicers associated with the workbook.
slicers?: Excel.Interfaces.SlicerData[];Property Value
Remarks
Represents a collection of SlicerStyles associated with the workbook.
slicerStyles?: Excel.Interfaces.SlicerStyleData[];Property Value
Remarks
Represents a collection of styles associated with the workbook.
styles?: Excel.Interfaces.StyleData[];Property Value
Remarks
Represents a collection of tables associated with the workbook.
tables?: Excel.Interfaces.TableData[];Property Value
Remarks
Represents a collection of TableStyles associated with the workbook.
tableStyles?: Excel.Interfaces.TableStyleData[];Property Value
Remarks
Represents a collection of TimelineStyles associated with the workbook.
timelineStyles?: Excel.Interfaces.TimelineStyleData[];Property Value
Remarks
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
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
Represents a collection of worksheets associated with the workbook.
worksheets?: Excel.Interfaces.WorksheetData[];Property Value
Remarks
Office Add-ins feedback
Office Add-ins is an open source project. Select a link to provide feedback: