Defines the collection of the Sheet objects.
constructor(data?: any[]): ObservableArray
Initializes a new instance of the ObservableArray class.
Array containing items used to populate the ObservableArray.
Gets a value that indicates whether notifications are currently suspended (see beginUpdate and endUpdate).
beginUpdate(): void
Suspends notifications until the next call to endUpdate.
clear(): void
Clear the SheetCollection.
deferUpdate(fn: Function): void
Executes a function within a beginUpdate/endUpdate block.
The collection will not be refreshed until the function finishes. This method ensures endUpdate is called even if the function throws an exception.
Function to be executed without updates.
endUpdate(): void
Resumes notifications suspended by a call to beginUpdate.
getValidSheetName(currentSheet: Sheet): string
Gets the valid name for the sheet.
hide(pos: number): boolean
Hides the sheet at the specified position.
The position of the sheet to hide.
implementsInterface(interfaceName: string): boolean
Returns true if the caller queries for a supported interface.
Name of the interface to look for.
The index where the search should start.
insert(index: number, item: any): void
Inserts an item at a specific position in the array. Overrides the insert method of its base class ObservableArray.
Position where the item will be added.
Item to add to the array.
isValidSheetName(sheet: Sheet): boolean
Checks whether the sheet name is valid.
onCollectionChanged(e?: NotifyCollectionChangedEventArgs): void
Raises the collectionChanged event.
Contains a description of the change.
onSelectedSheetChanged(e: PropertyChangedEventArgs): void
Raises the currentChanged event.
PropertyChangedEventArgs that contains the event data.
onSheetCleared(): void
Raises the sheetCleared event.
onSheetNameChanged(e: NotifyCollectionChangedEventArgs): void
Raises the sheetNameChanged event.
onSheetVisibleChanged(e: NotifyCollectionChangedEventArgs): void
Raises the sheetVisibleChanged event.
push(...item: any[]): number
Adds one or more items to the end of the array. Overrides the push method of its base class ObservableArray.
One or more items to add to the array.
remove(item: any): boolean
Removes an item from the array.
Item to remove.
removeAt(index: number): void
Removes an item at a specific position in the array. Overrides the removeAt method of its base class ObservableArray.
Position of the item to remove.
selectFirst(): boolean
Selects the first sheet in the FlexSheet control.
selectLast(): boolean
Selects the last sheet in the owner FlexSheet control.
selectNext(): boolean
Select the next sheet in the owner FlexSheet control.
selectPrevious(): boolean
Selects the previous sheet in the owner FlexSheet control.
setAt(index: number, item: any): void
Assigns an item at a specific position in the array.
Position where the item will be assigned.
Item to assign to the array.
show(pos: number): boolean
Unhide and selects the Sheet at the specified position.
The position of the sheet to show.
slice(begin?: number, end?: number): any[]
Creates a shallow copy of a portion of an array.
Position where the copy starts.
Position where the copy ends.
sort(compareFn?: Function): this
Sorts the elements of the array in place.
Specifies a function that defines the sort order. If specified, the function should take two arguments and should return -1, +1, or 0 to indicate the first argument is smaller, greater than, or equal to the second argument. If omitted, the array is sorted in dictionary order according to the string conversion of each element.
splice(index: number, count: number, item?: any): any[]
Removes and/or adds items to the array. Overrides the splice method of its base class ObservableArray.
Position where items will be added or removed.
Number of items to remove from the array.
Item to add to the array.
Occurs when the collection changes.
Occurs when the selectedIndex property changes.
Occurs after the name of the sheet in the collection has changed.
Occurs after the visible of the sheet in the collection has changed.