ListObjectCollection
Contents
[
Hide
]ListObjectCollection class
Represents a collection of ListObject objects in the worksheet.
class ListObjectCollection;
Methods
| Method | Description |
|---|---|
| get(number) | Gets the ListObject by index. |
| get(string) | Gets the ListObject by specified name. |
| add(number, number, number, number, boolean) | Adds a ListObject to the worksheet. |
| add(string, string, boolean) | Adds a ListObject to the worksheet. |
| updateColumnName() | Update all column name of the tables. |
get(number)
Gets the ListObject by index.
get(index: number) : ListObject;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
Returns
The ListObject
get(string)
Gets the ListObject by specified name.
get(tableName: string) : ListObject;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| tableName | string | ListObject name. |
Returns
The ListObject
add(number, number, number, number, boolean)
Adds a ListObject to the worksheet.
add(startRow: number, startColumn: number, endRow: number, endColumn: number, hasHeaders: boolean) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| startRow | number | The start row of the list range. |
| startColumn | number | The start row of the list range. |
| endRow | number | The start row of the list range. |
| endColumn | number | The start row of the list range. |
| hasHeaders | boolean | Whether the range has headers. |
Returns
The index of the new ListObject
add(string, string, boolean)
Adds a ListObject to the worksheet.
add(startCell: string, endCell: string, hasHeaders: boolean) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| startCell | string | The start cell of the list range. |
| endCell | string | The end cell of the list range. |
| hasHeaders | boolean | Whether the range has headers. |
Returns
The index of the new ListObject
updateColumnName()
Update all column name of the tables.
updateColumnName() : void;