ExcelScript.WorkbookRangeAreas interface
Represents a collection of one or more rectangular ranges in multiple worksheets.
Methods
get |
Returns an array of addresses in A1-style. Address values contain the worksheet name for each rectangular block of cells (e.g., "Sheet1!A1:B4, Sheet1!D1:D4"). Read-only. |
get |
Returns the |
get |
Returns the |
get |
Returns ranges that comprise this object in a |
Method Details
getAddresses()
Returns an array of addresses in A1-style. Address values contain the worksheet name for each rectangular block of cells (e.g., "Sheet1!A1:B4, Sheet1!D1:D4"). Read-only.
getAddresses(): string[];
Returns
string[]
getAreas()
Returns the RangeAreasCollection
object. Each RangeAreas
in the collection represent one or more rectangle ranges in one worksheet.
getAreas(): RangeAreas[];
Returns
getRangeAreasBySheet(key)
Returns the RangeAreas
object based on worksheet name or ID in the collection. If the worksheet does not exist, then this method returns undefined
.
getRangeAreasBySheet(key: string): RangeAreas;
Parameters
- key
-
string
The name or ID of the worksheet.
Returns
getRanges()
Returns ranges that comprise this object in a RangeCollection
object.
getRanges(): Range[];
Returns
Office Scripts
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for