A collection of cells or regions which are all on the same [[worksheet]].
Constructors
Section titled "Constructors"WorksheetReferenceCollection
new WorksheetReferenceCollection(worksheet: Worksheet): WorksheetReferenceCollectionReturns WorksheetReferenceCollection
Properties
Section titled "Properties"$t: TypeAccessors
Section titled "Accessors"cellsCount
Section titled "cellsCount"Gets the number of cells contains in all references in this collection.
get cellsCount(): numberReturns number
worksheet
Section titled "worksheet"Gets the worksheet for which this collection contains references.
get worksheet(): WorksheetReturns Worksheet
Methods
Section titled "Methods"Adds a region to the collection of references.
add(region: WorksheetRegion): voidParameters
- region:
WorksheetRegionThe region to add to the collection.
Returns void
clear
Section titled "clear"Clears all references from the collection.
clear(): voidReturns void
contains
Section titled "contains"Determines whether the collection contains the specified region.
contains(region: WorksheetRegion): booleanParameters
- region:
WorksheetRegionThe region to search for in the collection.
Returns boolean
getEnumerator
Section titled "getEnumerator"getEnumerator(): IEnumerator$1<WorksheetRegion>Returns IEnumerator$1<WorksheetRegion>
remove
Section titled "remove"Removes a region from the collection of references.
remove(region: WorksheetRegion): booleanParameters
- region:
WorksheetRegionThe region to remove from the collection.
Returns boolean
toString
Section titled "toString"Returns the string value represent the cell and region addresses in the collection.
toString(): string