Edit

Share via

Excel.Interfaces.WorksheetCollectionLoadOptions interface

  • Reference
Package:
excel

Represents a collection of worksheet objects that are part of the workbook.

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

For EACH ITEM in the collection: Returns a collection of charts that are part of the worksheet.
id

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: The display name of the worksheet. The name must be fewer than 32 characters.
position

For EACH ITEM in the collection: The zero-based position of the worksheet within the workbook.
protection

For EACH ITEM in the collection: Returns the sheet protection object for a worksheet.
tables

For EACH ITEM in the collection: Collection of tables that are part of the worksheet.
visibility

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: The zero-based position of the worksheet within the workbook.

position?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

protection

For EACH ITEM in the collection: Returns the sheet protection object for a worksheet.

protection?: Excel.Interfaces.WorksheetProtectionLoadOptions;

Property Value

Excel.Interfaces.WorksheetProtectionLoadOptions

Remarks

[ API set: ExcelApi 1.2 ]

tables

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: The visibility of the worksheet.

visibility?: boolean;

Property Value

boolean

Remarks

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