ReadonlyisFor runtime type checking.
ReadonlyisFor runtime type checking.
Iterates the collection's items.
The unfiltered walk — for (const sheet of wb.getSheets()). Every other iterable surface in
the SDK (ICellRange, ICellRegions, ICellRanges) reads this way, so a collection that did
not was a trap: for…of over one is the obvious line to write and it threw at runtime with
nothing in the types to warn first.
getItems remains the call that takes options — filtering, ordering, anything parameterized. This is sugar over the unfiltered case, not a replacement for it.
Adds a book at the end — the next [n] — with an empty cache.
Where the source is and, optionally, which sheets it has.
OptionaltxOptions: ITransaction.OperationOptionsAdd Listeners.
Optionaloptions: IListener.OptionsReturns the item at the given index, or undefined if there is none.
The position in iteration order. A negative index counts back from the end, as
Array.prototype.at does.
IExternalBook.breakLink for every book, in one undoable step — the pane's Break all.
OptionaltxOptions: ITransaction.OperationOptionsHow many books were broken. Gaps stay: a DDE/OLE slot has nothing to value.
Closes the collection; the workbook's to call.
Returns true if the predicate accepts every item, including when there are none.
Called once per item in iteration order until it returns false.
Returns the items the predicate accepts, in iteration order.
Called once per item.
Returns the items the predicate accepts, in iteration order.
Called once per item.
Returns the first item the predicate accepts, or undefined if it accepts none.
Called once per item in iteration order until it returns true.
Returns the first item the predicate accepts, or undefined if it accepts none.
Called once per item in iteration order until it returns true.
Returns the index of the first item the predicate accepts, or -1 if it accepts none.
Called once per item in iteration order until it returns true.
Calls the function once per item, in iteration order.
Called once per item.
The book carrying a runtime id, or null — for an unknown id and for a DDE/OLE gap alike,
since a gap has an id but no book.
Returns the items in the collection.
Optionaloptions: ICollection.GetItemsOptionsThe optioned call — filtering, ordering, anything parameterized — and a snapshot: the array returned does not follow later changes to the collection. For the unfiltered items as a plain array prefer toArray.
Returns the index of the item in iteration order, or -1 if it is not in the collection.
The item to find.
Returns true once the collection has been closed.
A closed collection is empty and announces nothing further. Collections that are closed by
their owner (the workbook's names, functions and modules, when the workbook closes) announce
it once with ICollection.Events.onClose; the others are never closed and always
return false.
Returns the result of calling the function on every item, in iteration order.
Called once per item.
IExternalBook.refresh for every book, in order — the pane's Refresh all.
One result per book. Without a resolver every one is 'unavailable'.
Returns true if the predicate accepts at least one item.
Called once per item in iteration order until it returns true.
Returns the items as a fresh array, in iteration order.
The positional array, gaps included — null at index i means [i+1] is a DDE/OLE
link or otherwise unmodeled, not that it is absent. null overall if there are no entries at
all (nothing to preserve).
The workbook's external books, in
[n]order.Remarks
Positional, not a key — see IExternalBook.
[n]in a formula is this collection's index at read time; nothing in the source file names a book any other way.A link is created by a formula and removed by breaking it — Excel's model, and ours. Typing
'C:\path\[Budget.xlsx]Sheet1'!A1into a cell adds a book here with an empty cache; add is the same step without the formula. IExternalBook.breakLink is what Excel's Workbook Links pane does: every citing formula becomes its values, then the slot goes.