Excel.Interfaces.WorksheetLoadOptions interface

An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc.

[ API set: ExcelApi 1.1 ]

Properties

$all
autoFilter

Represents the AutoFilter object of the worksheet.

[ API set: ExcelApi 1.9 ]

charts

Returns collection of charts that are part of the worksheet.

[ API set: ExcelApi 1.1 ]

enableCalculation

Gets or sets the enableCalculation property of the worksheet. True if Excel recalculates the worksheet when necessary. False if Excel doesn't recalculate the sheet.

[ API set: ExcelApi 1.9 ]

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. Read-only.

[ API set: ExcelApi 1.1 ]

name

The display name of the worksheet.

[ API set: ExcelApi 1.1 ]

pageLayout

Gets the PageLayout object of the worksheet.

[ API set: ExcelApi 1.9 ]

position

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

[ API set: ExcelApi 1.1 ]

protection

Returns sheet protection object for a worksheet.

[ API set: ExcelApi 1.2 ]

showGridlines

Gets or sets the worksheet's gridlines flag. This flag determines whether gridlines are visible to the user.

[ API set: ExcelApi 1.8 ]

showHeadings

Gets or sets the worksheet's headings flag. This flag determines whether headings are visible to the user.

[ API set: ExcelApi 1.8 ]

standardHeight

Returns the standard (default) height of all the rows in the worksheet, in points. Read-only.

[ API set: ExcelApi 1.7 ]

standardWidth

Returns or sets 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.

[ API set: ExcelApi 1.7 ]

tabColor

Gets or sets the worksheet tab color. 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 "#123456" When setting the color, use an empty-string to set an "auto" color, or a real color otherwise.

[ API set: ExcelApi 1.7 ]

tables

Collection of tables that are part of the worksheet.

[ API set: ExcelApi 1.1 ]

visibility

The Visibility of the worksheet.

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

Property Details

$all

$all?: boolean;

Property Value

boolean

autoFilter

Represents the AutoFilter object of the worksheet.

[ API set: ExcelApi 1.9 ]

autoFilter?: Excel.Interfaces.AutoFilterLoadOptions;

Property Value

charts

Returns collection of charts that are part of the worksheet.

[ API set: ExcelApi 1.1 ]

charts?: Excel.Interfaces.ChartCollectionLoadOptions;

Property Value

enableCalculation

Gets or sets the enableCalculation property of the worksheet. True if Excel recalculates the worksheet when necessary. False if Excel doesn't recalculate the sheet.

[ API set: ExcelApi 1.9 ]

enableCalculation?: boolean;

Property Value

boolean

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. Read-only.

[ API set: ExcelApi 1.1 ]

id?: boolean;

Property Value

boolean

name

The display name of the worksheet.

[ API set: ExcelApi 1.1 ]

name?: boolean;

Property Value

boolean

pageLayout

Gets the PageLayout object of the worksheet.

[ API set: ExcelApi 1.9 ]

pageLayout?: Excel.Interfaces.PageLayoutLoadOptions;

Property Value

position

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

[ API set: ExcelApi 1.1 ]

position?: boolean;

Property Value

boolean

protection

Returns sheet protection object for a worksheet.

[ API set: ExcelApi 1.2 ]

protection?: Excel.Interfaces.WorksheetProtectionLoadOptions;

Property Value

showGridlines

Gets or sets the worksheet's gridlines flag. This flag determines whether gridlines are visible to the user.

[ API set: ExcelApi 1.8 ]

showGridlines?: boolean;

Property Value

boolean

showHeadings

Gets or sets the worksheet's headings flag. This flag determines whether headings are visible to the user.

[ API set: ExcelApi 1.8 ]

showHeadings?: boolean;

Property Value

boolean

standardHeight

Returns the standard (default) height of all the rows in the worksheet, in points. Read-only.

[ API set: ExcelApi 1.7 ]

standardHeight?: boolean;

Property Value

boolean

standardWidth

Returns or sets 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.

[ API set: ExcelApi 1.7 ]

standardWidth?: boolean;

Property Value

boolean

tabColor

Gets or sets the worksheet tab color. 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 "#123456" When setting the color, use an empty-string to set an "auto" color, or a real color otherwise.

[ API set: ExcelApi 1.7 ]

tabColor?: boolean;

Property Value

boolean

tables

Collection of tables that are part of the worksheet.

[ API set: ExcelApi 1.1 ]

tables?: Excel.Interfaces.TableCollectionLoadOptions;

Property Value

visibility

The Visibility of the worksheet.

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

visibility?: boolean;

Property Value

boolean