Edit

Share via

Excel.Interfaces.WorksheetLoadOptions interface

  • Reference
Package:
excel

An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. To learn more about the worksheet object model, read Work with worksheets 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).
charts

Returns a collection of charts that are part of the worksheet.
id

Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved.
name

The display name of the worksheet. The name must be fewer than 32 characters.
position

The zero-based position of the worksheet within the workbook.
protection

Returns the sheet protection object for a worksheet.
tables

Collection of tables that are part of the worksheet.
visibility

The visibility of the worksheet.

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

charts

Returns a collection of charts that are part of the worksheet.

charts?: Excel.Interfaces.ChartCollectionLoadOptions;

Property Value

Excel.Interfaces.ChartCollectionLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

id

Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved.

id?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

name

The display name of the worksheet. The name must be fewer than 32 characters.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

position

The zero-based position of the worksheet within the workbook.

position?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

protection

Returns the sheet protection object for a worksheet.

protection?: Excel.Interfaces.WorksheetProtectionLoadOptions;

Property Value

Excel.Interfaces.WorksheetProtectionLoadOptions

Remarks

[ API set: ExcelApi 1.2 ]

tables

Collection of tables that are part of the worksheet.

tables?: Excel.Interfaces.TableCollectionLoadOptions;

Property Value

Excel.Interfaces.TableCollectionLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

visibility

The visibility of the worksheet.

visibility?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 for reading visibility; 1.2 for setting it. ]