Excel.Interfaces.WorkbookData interface

Package:

excel

An interface describing the data returned by calling workbook.toJSON().

Properties

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.
customXmlParts	Represents the collection of custom XML parts contained by this workbook.
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.
name	Gets the workbook name.
names	Represents a collection of workbook-scoped named items (named ranges and constants).
pivotTables	Represents a collection of PivotTables associated with the workbook.
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.
settings	Represents a collection of settings associated with the workbook.
styles	Represents a collection of styles associated with the workbook.
tables	Represents a collection of tables associated with the workbook.
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.
worksheets	Represents a collection of worksheets associated with the workbook.

Property Details

autoSave

Specifies if the workbook is in AutoSave mode.

TypeScript

autoSave?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

bindings

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

TypeScript

bindings?: Excel.Interfaces.BindingData[];

Property Value

Excel.Interfaces.BindingData[]

Remarks

[ API set: ExcelApi 1.1 ]

calculationEngineVersion

Returns a number about the version of Excel Calculation Engine.

TypeScript

calculationEngineVersion?: number;

Property Value

number

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.

TypeScript

chartDataPointTrack?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

customXmlParts

Represents the collection of custom XML parts contained by this workbook.

TypeScript

customXmlParts?: Excel.Interfaces.CustomXmlPartData[];

Property Value

Excel.Interfaces.CustomXmlPartData[]

Remarks

[ API set: ExcelApi 1.5 ]

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.

TypeScript

isDirty?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

name

Gets the workbook name.

TypeScript

name?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.7 ]

names

Represents a collection of workbook-scoped named items (named ranges and constants).

TypeScript

names?: Excel.Interfaces.NamedItemData[];

Property Value

Excel.Interfaces.NamedItemData[]

Remarks

[ API set: ExcelApi 1.1 ]

pivotTables

Represents a collection of PivotTables associated with the workbook.

TypeScript

pivotTables?: Excel.Interfaces.PivotTableData[];

Property Value

Excel.Interfaces.PivotTableData[]

Remarks

[ API set: ExcelApi 1.3 ]

previouslySaved

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

TypeScript

previouslySaved?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

properties

Gets the workbook properties.

TypeScript

properties?: Excel.Interfaces.DocumentPropertiesData;

Property Value

Excel.Interfaces.DocumentPropertiesData

Remarks

[ API set: ExcelApi 1.7 ]

protection

Returns the protection object for a workbook.

TypeScript

protection?: Excel.Interfaces.WorkbookProtectionData;

Property Value

Excel.Interfaces.WorkbookProtectionData

Remarks

[ API set: ExcelApi 1.7 ]

readOnly

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

TypeScript

readOnly?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

settings

Represents a collection of settings associated with the workbook.

TypeScript

settings?: Excel.Interfaces.SettingData[];

Property Value

Excel.Interfaces.SettingData[]

Remarks

[ API set: ExcelApi 1.4 ]

styles

Represents a collection of styles associated with the workbook.

TypeScript

styles?: Excel.Interfaces.StyleData[];

Property Value

Excel.Interfaces.StyleData[]

Remarks

[ API set: ExcelApi 1.7 ]

tables

Represents a collection of tables associated with the workbook.

TypeScript

tables?: Excel.Interfaces.TableData[];

Property Value

Excel.Interfaces.TableData[]

Remarks

[ API set: ExcelApi 1.1 ]

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.

TypeScript

usePrecisionAsDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

worksheets

Represents a collection of worksheets associated with the workbook.

TypeScript

worksheets?: Excel.Interfaces.WorksheetData[];

Property Value

Excel.Interfaces.WorksheetData[]

Remarks

[ API set: ExcelApi 1.1 ]