Excel.Interfaces.WorkbookData interface
An interface describing the data returned by calling workbook.toJSON().
Properties
| 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. |
| 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). |
| 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. |
| 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. |
| 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. |
Property Details
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.BindingData[];Property Value
Remarks
calculationEngineVersion
Returns a number about the version of Excel Calculation Engine.
calculationEngineVersion?: number;Property Value
number
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
comments
Represents a collection of comments associated with the workbook.
comments?: Excel.Interfaces.CommentData[];Property Value
Remarks
customXmlParts
Represents the collection of custom XML parts contained by this workbook.
customXmlParts?: Excel.Interfaces.CustomXmlPartData[];Property Value
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
name
names
Represents a collection of workbook-scoped named items (named ranges and constants).
names?: Excel.Interfaces.NamedItemData[];Property Value
Remarks
pivotTables
Represents a collection of PivotTables associated with the workbook.
pivotTables?: Excel.Interfaces.PivotTableData[];Property Value
Remarks
pivotTableStyles
Represents a collection of PivotTableStyles associated with the workbook.
pivotTableStyles?: Excel.Interfaces.PivotTableStyleData[];Property Value
Remarks
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.DocumentPropertiesData;Property Value
Remarks
protection
Returns the protection object for a workbook.
protection?: Excel.Interfaces.WorkbookProtectionData;Property Value
Remarks
readOnly
Returns true if the workbook is open in read-only mode.
readOnly?: boolean;Property Value
boolean
Remarks
settings
Represents a collection of settings associated with the workbook.
settings?: Excel.Interfaces.SettingData[];Property Value
Remarks
slicers
Represents a collection of slicers associated with the workbook.
slicers?: Excel.Interfaces.SlicerData[];Property Value
Remarks
slicerStyles
Represents a collection of SlicerStyles associated with the workbook.
slicerStyles?: Excel.Interfaces.SlicerStyleData[];Property Value
Remarks
styles
Represents a collection of styles associated with the workbook.
styles?: Excel.Interfaces.StyleData[];Property Value
Remarks
tables
Represents a collection of tables associated with the workbook.
tables?: Excel.Interfaces.TableData[];Property Value
Remarks
tableStyles
Represents a collection of TableStyles associated with the workbook.
tableStyles?: Excel.Interfaces.TableStyleData[];Property Value
Remarks
timelineStyles
Represents a collection of TimelineStyles associated with the workbook.
timelineStyles?: Excel.Interfaces.TimelineStyleData[];Property Value
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
worksheets
Represents a collection of worksheets associated with the workbook.
worksheets?: Excel.Interfaces.WorksheetData[];Property Value
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