Excel.Interfaces.WorksheetCollectionLoadOptions interface

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 LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
autoFilter	For EACH ITEM in the collection: Represents the AutoFilter object of the worksheet.
charts	For EACH ITEM in the collection: Returns a collection of charts that are part of the worksheet.
enableCalculation	For EACH ITEM in the collection: Determines if Excel should recalculate the worksheet when necessary. True if Excel recalculates the worksheet when necessary. False if Excel doesn't recalculate the sheet.
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.
pageLayout	For EACH ITEM in the collection: Gets the PageLayout object of the worksheet.
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.
showGridlines	For EACH ITEM in the collection: Specifies if gridlines are visible to the user.
showHeadings	For EACH ITEM in the collection: Specifies if headings are visible to the user.
standardHeight	For EACH ITEM in the collection: Returns the standard (default) height of all the rows in the worksheet, in points.
standardWidth	For EACH ITEM in the collection: Specifies the standard (default) width of all the columns in the worksheet. One unit of column width is equal to the width of one character in the Normal style. For proportional fonts, the width of the character 0 (zero) is used.
tabColor	For EACH ITEM in the collection: The tab color of the worksheet. When retrieving the tab color, if the worksheet is invisible, the value will be null. If the worksheet is visible but the tab color is set to auto, an empty string will be returned. Otherwise, the property will be set to a color, in the form #RRGGBB (e.g., "FFA500"). When setting the color, use an empty-string to set an "auto" color, or a real color otherwise.
tabId	For EACH ITEM in the collection: Returns a value representing this worksheet that can be read by Open Office XML. This is an integer value, which is different from worksheet.id (which returns a globally unique identifier) and worksheet.name (which returns a value such as "Sheet1").
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 LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

autoFilter

For EACH ITEM in the collection: Represents the AutoFilter object of the worksheet.

autoFilter?: Excel.Interfaces.AutoFilterLoadOptions;

Property Value

Excel.Interfaces.AutoFilterLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]

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 ]

enableCalculation

For EACH ITEM in the collection: Determines if Excel should recalculate the worksheet when necessary. True if Excel recalculates the worksheet when necessary. False if Excel doesn't recalculate the sheet.

enableCalculation?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

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.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

pageLayout

For EACH ITEM in the collection: Gets the PageLayout object of the worksheet.

pageLayout?: Excel.Interfaces.PageLayoutLoadOptions;

Property Value

Excel.Interfaces.PageLayoutLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]

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 ]

showGridlines

For EACH ITEM in the collection: Specifies if gridlines are visible to the user.

showGridlines?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

showHeadings

For EACH ITEM in the collection: Specifies if headings are visible to the user.

showHeadings?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

standardHeight

For EACH ITEM in the collection: Returns the standard (default) height of all the rows in the worksheet, in points.

standardHeight?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

standardWidth

For EACH ITEM in the collection: Specifies the standard (default) width of all the columns in the worksheet. One unit of column width is equal to the width of one character in the Normal style. For proportional fonts, the width of the character 0 (zero) is used.

standardWidth?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

tabColor

For EACH ITEM in the collection: The tab color of the worksheet. When retrieving the tab color, if the worksheet is invisible, the value will be null. If the worksheet is visible but the tab color is set to auto, an empty string will be returned. Otherwise, the property will be set to a color, in the form #RRGGBB (e.g., "FFA500"). When setting the color, use an empty-string to set an "auto" color, or a real color otherwise.

tabColor?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

tabId

For EACH ITEM in the collection: Returns a value representing this worksheet that can be read by Open Office XML. This is an integer value, which is different from worksheet.id (which returns a globally unique identifier) and worksheet.name (which returns a value such as "Sheet1").

tabId?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.14 ]

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. ]