Edit

Share via

Excel.Interfaces.WorkbookLoadOptions interface

  • Reference
Package:
excel

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

[ API set: ExcelApi 1.1 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
application

Represents the Excel application instance that contains this workbook.
bindings

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

Gets the workbook name.
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.
tables

Represents a collection of tables associated with the workbook.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as 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

Excel.Interfaces.ApplicationLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

bindings

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

bindings?: Excel.Interfaces.BindingCollectionLoadOptions;

Property Value

Excel.Interfaces.BindingCollectionLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

name

Gets the workbook name.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

properties

Gets the workbook properties.

properties?: Excel.Interfaces.DocumentPropertiesLoadOptions;

Property Value

Excel.Interfaces.DocumentPropertiesLoadOptions

Remarks

[ API set: ExcelApi 1.7 ]

protection

Returns the protection object for a workbook.

protection?: Excel.Interfaces.WorkbookProtectionLoadOptions;

Property Value

Excel.Interfaces.WorkbookProtectionLoadOptions

Remarks

[ API set: ExcelApi 1.7 ]

readOnly

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

readOnly?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

tables

Represents a collection of tables associated with the workbook.

tables?: Excel.Interfaces.TableCollectionLoadOptions;

Property Value

Excel.Interfaces.TableCollectionLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]