Excel.Interfaces.WorkbookData interface

Package:

excel

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

Properties

bindings	Represents a collection of bindings that are part of the workbook.
customXmlParts	Represents the collection of custom XML parts contained by this workbook.
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.
properties	Gets the workbook properties.
protection	Returns the protection object for a workbook.
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.
worksheets	Represents a collection of worksheets associated with the workbook.

Property Details

bindings

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

bindings?: Excel.Interfaces.BindingData[];

Property Value

Excel.Interfaces.BindingData[]

Remarks

[ API set: ExcelApi 1.1 ]

customXmlParts

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

customXmlParts?: Excel.Interfaces.CustomXmlPartData[];

Property Value

Excel.Interfaces.CustomXmlPartData[]

Remarks

[ API set: ExcelApi 1.5 ]

name

Gets the workbook name.

name?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.7 ]

names

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

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.

pivotTables?: Excel.Interfaces.PivotTableData[];

Property Value

Excel.Interfaces.PivotTableData[]

Remarks

[ API set: ExcelApi 1.3 ]

properties

Gets the workbook properties.

properties?: Excel.Interfaces.DocumentPropertiesData;

Property Value

Excel.Interfaces.DocumentPropertiesData

Remarks

[ API set: ExcelApi 1.7 ]

protection

Returns the protection object for a workbook.

protection?: Excel.Interfaces.WorkbookProtectionData;

Property Value

Excel.Interfaces.WorkbookProtectionData

Remarks

[ API set: ExcelApi 1.7 ]

settings

Represents a collection of settings associated with the workbook.

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.

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.

tables?: Excel.Interfaces.TableData[];

Property Value

Excel.Interfaces.TableData[]

Remarks

[ API set: ExcelApi 1.1 ]

worksheets

Represents a collection of worksheets associated with the workbook.

worksheets?: Excel.Interfaces.WorksheetData[];

Property Value

Excel.Interfaces.WorksheetData[]

Remarks

[ API set: ExcelApi 1.1 ]