Excel.Interfaces.WorksheetCollectionLoadOptions interface
Represents a collection of worksheet objects that are part of the workbook.
Remarks
Properties
| $all | Specifying |
| auto |
For EACH ITEM in the collection: Represents the |
| charts | For EACH ITEM in the collection: Returns a collection of charts that are part of the worksheet. |
| enable |
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. The name must be fewer than 32 characters. |
| page |
For EACH ITEM in the collection: Gets the |
| 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. |
| show |
For EACH ITEM in the collection: Specifies if gridlines are visible to the user. |
| show |
For EACH ITEM in the collection: Specifies if headings are visible to the user. |
| standard |
For EACH ITEM in the collection: Returns the standard (default) height of all the rows in the worksheet, in points. |
| standard |
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. |
| tab |
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 |
| tab |
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 |
| 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
autoFilter
For EACH ITEM in the collection: Represents the AutoFilter object of the worksheet.
autoFilter?: Excel.Interfaces.AutoFilterLoadOptions;Property Value
Remarks
charts
For EACH ITEM in the collection: Returns a collection of charts that are part of the worksheet.
charts?: Excel.Interfaces.ChartCollectionLoadOptions;Property Value
Remarks
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
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
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
pageLayout
For EACH ITEM in the collection: Gets the PageLayout object of the worksheet.
pageLayout?: Excel.Interfaces.PageLayoutLoadOptions;Property Value
Remarks
position
For EACH ITEM in the collection: The zero-based position of the worksheet within the workbook.
position?: boolean;Property Value
boolean
Remarks
protection
For EACH ITEM in the collection: Returns the sheet protection object for a worksheet.
protection?: Excel.Interfaces.WorksheetProtectionLoadOptions;Property Value
Remarks
showGridlines
For EACH ITEM in the collection: Specifies if gridlines are visible to the user.
showGridlines?: boolean;Property Value
boolean
Remarks
showHeadings
For EACH ITEM in the collection: Specifies if headings are visible to the user.
showHeadings?: boolean;Property Value
boolean
Remarks
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
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
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
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
tables
For EACH ITEM in the collection: Collection of tables that are part of the worksheet.
tables?: Excel.Interfaces.TableCollectionLoadOptions;Property Value
Remarks
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. ]
Office Add-ins