Defines the collection of the Sheet objects.
constructor(owner?: FlexSheet, grid?: FlexGrid, sheetName?: string, rows?: number, cols?: number): Sheet
Initializes a new instance of the Sheet class.
The owner FlexSheet control.
The associated FlexGrid control used to store the sheet data. If not specified then the new FlexGrid control will be created.
The name of the sheet within the FlexSheet control.
The row count for the sheet.
The column count for the sheet.
Gets or sets the filter setting for this sheet.
Gets the associated FlexGrid control used to store the sheet data.
Gets or sets the array or ICollectionView for the FlexGrid instance of the sheet.
Gets the collection of the Table objects on this Sheet. It allows to insert/remove Table on this Sheet via the tables collection.
addTableFromArray(row: number, column: number, array: any[], properties?: string[], tableName?: string, tableStyle?: TableStyle, options?: ITableOptions, shift?: boolean): Table
Add table from an object array.
The row position of the table.
The column position of the table.
The object array load to the table.
It allows to retrieve only a subset of columns from the object of the array. If it is omitted, the table will load all the keys of the object of the array.
The name of the table.
The table style is applied to the table.
The options ITableOptions of the table.
Indicates whether cells beneath the table should be shifted or not. If not specified cells beneath will be shifted.
clear(): void
Clear the SheetCollection.
findTable(rowIndex: number, columnIndex: number): Table
Finds the table via the cell location.
getCellStyle(rowIndex: number, columnIndex: number): ICellStyle
Gets the style of specified cell.
the row index of the specified cell.
the column index of the specified cell.
getValidSheetName(currentSheet: T): string
Gets the valid name for the sheet.
The Sheet need get the valid name.
hide(pos: number): boolean
Hides the sheet at the specified position.
The position of the sheet to hide.
isValidSheetName(sheet: T): boolean
Checks whether the sheet name is valid.
The Sheet for which the name needs to check.
onNameChanged(e: PropertyChangedEventArgs): void
Raises the nameChanged event.
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.
onVisibleChanged(e: EventArgs): void
Raises the visibleChanged event.
push(...item: T[]): 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.
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.
show(pos: number): boolean
Unhide and selects the Sheet at the specified position.
The position of the sheet to show.
splice(index: number, count: number, ...item: T[]): 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.
Items to add to the array.
Occurs after the sheet name has changed.
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.