HtmlTableLoadOptionCollection

HtmlTableLoadOptionCollection class

Represents the table options when importing html.

class HtmlTableLoadOptionCollection;

Constructors

ConstructorDescription
constructor()Default Constructor.

Properties

PropertyTypeDescription
tableToListObjectbooleanIndicates whether generate list objects from imported tables. The default value is false.

Methods

MethodDescription
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:

ParameterTypeDescription
indexnumberThe 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:

ParameterTypeDescription
valuebooleanThe value to set.

add(HtmlTableLoadOption)

Adds one HtmlTableLoadOption into this collection.

add(item: HtmlTableLoadOption) : number;

Parameters:

ParameterTypeDescription
itemHtmlTableLoadOptionone HtmlTableLoadOption

Returns

the index of the added item

add(number)

Add a HtmlTableLoadOption to the list.

add(tableIndex: number) : number;

Parameters:

ParameterTypeDescription
tableIndexnumberTable index

add(string)

Add a HtmlTableLoadOption to the list.

add(tableId: string) : number;

Parameters:

ParameterTypeDescription
tableIdstringTable ID

add(number, number)

Add a HtmlTableLoadOption to the list.

add(tableIndex: number, targetSheetIndex: number) : number;

Parameters:

ParameterTypeDescription
tableIndexnumberTable index
targetSheetIndexnumberThe target index of worksheet in Excel

add(string, number)

Add a HtmlTableLoadOption to the list.

add(tableId: string, targetSheetIndex: number) : number;

Parameters:

ParameterTypeDescription
tableIdstringTable ID
targetSheetIndexnumberThe 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:

ParameterTypeDescription
tableIndexnumberTable index
targetSheetIndexnumberThe target index of worksheet in Excel
originalSheetIndexnumberThe 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:

ParameterTypeDescription
tableIdstringTable ID
targetSheetIndexnumberThe target index of worksheet in Excel
originalSheetIndexnumberThe 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;