TExcelFile.GetTable Method
Overloads
TExcelFile.GetTable(string)
Returns the definition for a table in the file. Note that this method will return any table in the file, not only in the active sheet, as table names are unique in the whole workbook. You can find which sheet the table is in with GetTableSheet
Syntax
Unit: FlexCel.Core
function TExcelFile.GetTable(const tableName: string): ITableDefinition; overload;Parameters
| <-> | Parameter | Type | Description |
|---|---|---|---|
| const | tableName | string | Name of the table. |
Returns
Null if the table doesn't exist, or the table definition otherwise.
See also
TExcelFile.GetTable(Integer)
Returns the table definition for the table at position tableIndex, for the active sheet. (1 based)
Syntax
Unit: FlexCel.Core
function TExcelFile.GetTable(const tableIndex: Integer): ITableDefinition; overload; virtual; abstract;Parameters
| <-> | Parameter | Type | Description |
|---|---|---|---|
| const | tableIndex | Integer | Position of the table in the active sheet. (1-based) |
Returns
The table definition. If tableIndex is out of range, then it will throw an Exception.
See also
TExcelFile.GetTable(string, Boolean)
Returns the definition for a table in the file. Note that this method will return any table in the file, not only in the active sheet, as table names are unique in the whole workbook. You can find which sheet the table is in with GetTableSheet
Syntax
Unit: FlexCel.Core
function TExcelFile.GetTable(const tableName: string; const ignoreFormulas: Boolean): ITableDefinition; overload; virtual; abstract;Parameters
| <-> | Parameter | Type | Description |
|---|---|---|---|
| const | tableName | string | Name of the table. |
| const | ignoreFormulas | Boolean | If true, this method won't return the formulas for the totals and the column. This parameter allows to get the table a little faster, when you are not interested in the formulas. |
Returns
Null if the table doesn't exist, or the table definition otherwise.