Edit

Share via

Excel.Interfaces.WorksheetUpdateData interface

  • Reference
Package:
excel

An interface for updating data on the Worksheet object, for use in worksheet.set({ ... }).

Properties

enableCalculation

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

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

Gets the PageLayout object of the worksheet.
position

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

Specifies if data type icons are visible on the worksheet. By default, data type icons are visible.
showGridlines

Specifies if gridlines are visible to the user.
showHeadings

Specifies if headings are visible to the user.
standardWidth

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

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

The visibility of the worksheet.

Property Details

enableCalculation

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 ]

name

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

name?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.1 ]

pageLayout

Gets the PageLayout object of the worksheet.

pageLayout?: Excel.Interfaces.PageLayoutUpdateData;

Property Value

Excel.Interfaces.PageLayoutUpdateData

Remarks

[ API set: ExcelApi 1.9 ]

position

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

position?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.1 ]

showDataTypeIcons

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies if data type icons are visible on the worksheet. By default, data type icons are visible.

showDataTypeIcons?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

showGridlines

Specifies if gridlines are visible to the user.

showGridlines?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

showHeadings

Specifies if headings are visible to the user.

showHeadings?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

standardWidth

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?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

tabColor

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?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.7 ]

visibility

The visibility of the worksheet.

visibility?: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";

Property Value

Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"

Remarks

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