HtmlTableLoadOptionCollection
HtmlTableLoadOptionCollection class
Represents the table options when importing html.
class HtmlTableLoadOptionCollection;
Constructors
| Constructor | Description |
|---|---|
| constructor() | Default Constructor. |
Properties
| Property | Type | Description |
|---|---|---|
| tableToListObject | boolean | Indicates whether generate list objects from imported tables. The default value is false. |
Methods
| Method | Description |
|---|---|
| get(number) | Gets the HtmlTableLoadOption element at the specified index. |
| getTableToListObject() | @deprecated. Please use the ’tableToListObject’ property instead. Indicates whether generate list objects from imported tables. The default value is false. |
| setTableToListObject(boolean) | @deprecated. Please use the ’tableToListObject’ property instead. Indicates whether generate list objects from imported tables. The default value is false. |
| add(HtmlTableLoadOption) | Adds one HtmlTableLoadOption into this collection. |
| add(number) | Add a HtmlTableLoadOption to the list. |
| add(string) | Add a HtmlTableLoadOption to the list. |
| add(number, number) | Add a HtmlTableLoadOption to the list. |
| add(string, number) | Add a HtmlTableLoadOption to the list. |
| add(number, number, number) | Add a HtmlTableLoadOption to the list. |
| add(string, number, number) | Add a HtmlTableLoadOption to the list. |
| getCount() | @deprecated. Please use the ‘count’ property instead. Gets the number of elements contained in. |
| isNull() | Checks whether the implementation object is null. |
constructor()
Default Constructor.
constructor();
tableToListObject
Indicates whether generate list objects from imported tables. The default value is false.
tableToListObject : boolean;
get(number)
Gets the HtmlTableLoadOption element at the specified index.
get(index: number) : HtmlTableLoadOption;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number | The zero based index of the element. |
Returns
The element at the specified index.
getTableToListObject()
@deprecated. Please use the ’tableToListObject’ property instead. Indicates whether generate list objects from imported tables. The default value is false.
getTableToListObject() : boolean;
setTableToListObject(boolean)
@deprecated. Please use the ’tableToListObject’ property instead. Indicates whether generate list objects from imported tables. The default value is false.
setTableToListObject(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
add(HtmlTableLoadOption)
Adds one HtmlTableLoadOption into this collection.
add(item: HtmlTableLoadOption) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| item | HtmlTableLoadOption | one HtmlTableLoadOption |
Returns
the index of the added item
add(number)
Add a HtmlTableLoadOption to the list.
add(tableIndex: number) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| tableIndex | number | Table index |
add(string)
Add a HtmlTableLoadOption to the list.
add(tableId: string) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| tableId | string | Table ID |
add(number, number)
Add a HtmlTableLoadOption to the list.
add(tableIndex: number, targetSheetIndex: number) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| tableIndex | number | Table index |
| targetSheetIndex | number | The target index of worksheet in Excel |
add(string, number)
Add a HtmlTableLoadOption to the list.
add(tableId: string, targetSheetIndex: number) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| tableId | string | Table ID |
| targetSheetIndex | number | The target index of worksheet in Excel |
add(number, number, number)
Add a HtmlTableLoadOption to the list.
add(tableIndex: number, targetSheetIndex: number, originalSheetIndex: number) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| tableIndex | number | Table index |
| targetSheetIndex | number | The target index of worksheet in Excel |
| originalSheetIndex | number | The original index of worksheet in the html |
add(string, number, number)
Add a HtmlTableLoadOption to the list.
add(tableId: string, targetSheetIndex: number, originalSheetIndex: number) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| tableId | string | Table ID |
| targetSheetIndex | number | The target index of worksheet in Excel |
| originalSheetIndex | number | The original index of worksheet in the html |
getCount()
@deprecated. Please use the ‘count’ property instead. Gets the number of elements contained in.
getCount() : number;
isNull()
Checks whether the implementation object is null.
isNull() : boolean;