HtmlTableLoadOption

HtmlTableLoadOption class

Represents the option when import table from html.

class HtmlTableLoadOption;

Constructors

ConstructorDescription
constructor()Default Constructor.

Properties

PropertyTypeDescription
tableIndexnumberGet or set the index of table to import from html.
idstringGet or set the id of table to import from html
namestringGet or set the name of table to import from html
originalSheetIndexnumberGet or set the original index of worksheet in the html.
targetSheetIndexnumberGet or set the target index of worksheet where the table is to be located.
tableToListObjectbooleanIndicates whether generate list objects from imported table. The default value is false.

Methods

MethodDescription
getTableIndex()@deprecated. Please use the ’tableIndex’ property instead. Get or set the index of table to import from html.
setTableIndex(number)@deprecated. Please use the ’tableIndex’ property instead. Get or set the index of table to import from html.
getId()@deprecated. Please use the ‘id’ property instead. Get or set the id of table to import from html
setId(string)@deprecated. Please use the ‘id’ property instead. Get or set the id of table to import from html
getName()@deprecated. Please use the ’name’ property instead. Get or set the name of table to import from html
setName(string)@deprecated. Please use the ’name’ property instead. Get or set the name of table to import from html
getOriginalSheetIndex()@deprecated. Please use the ‘originalSheetIndex’ property instead. Get or set the original index of worksheet in the html.
setOriginalSheetIndex(number)@deprecated. Please use the ‘originalSheetIndex’ property instead. Get or set the original index of worksheet in the html.
getTargetSheetIndex()@deprecated. Please use the ’targetSheetIndex’ property instead. Get or set the target index of worksheet where the table is to be located.
setTargetSheetIndex(number)@deprecated. Please use the ’targetSheetIndex’ property instead. Get or set the target index of worksheet where the table is to be located.
getTableToListObject()@deprecated. Please use the ’tableToListObject’ property instead. Indicates whether generate list objects from imported table. The default value is false.
setTableToListObject(boolean)@deprecated. Please use the ’tableToListObject’ property instead. Indicates whether generate list objects from imported table. The default value is false.
isNull()Checks whether the implementation object is null.

constructor()

Default Constructor.

constructor();

tableIndex

Get or set the index of table to import from html.

tableIndex : number;

id

Get or set the id of table to import from html

id : string;

name

Get or set the name of table to import from html

name : string;

originalSheetIndex

Get or set the original index of worksheet in the html.

originalSheetIndex : number;

targetSheetIndex

Get or set the target index of worksheet where the table is to be located.

targetSheetIndex : number;

tableToListObject

Indicates whether generate list objects from imported table. The default value is false.

tableToListObject : boolean;

getTableIndex()

@deprecated. Please use the ’tableIndex’ property instead. Get or set the index of table to import from html.

getTableIndex() : number;

setTableIndex(number)

@deprecated. Please use the ’tableIndex’ property instead. Get or set the index of table to import from html.

setTableIndex(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getId()

@deprecated. Please use the ‘id’ property instead. Get or set the id of table to import from html

getId() : string;

setId(string)

@deprecated. Please use the ‘id’ property instead. Get or set the id of table to import from html

setId(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getName()

@deprecated. Please use the ’name’ property instead. Get or set the name of table to import from html

getName() : string;

setName(string)

@deprecated. Please use the ’name’ property instead. Get or set the name of table to import from html

setName(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getOriginalSheetIndex()

@deprecated. Please use the ‘originalSheetIndex’ property instead. Get or set the original index of worksheet in the html.

getOriginalSheetIndex() : number;

setOriginalSheetIndex(number)

@deprecated. Please use the ‘originalSheetIndex’ property instead. Get or set the original index of worksheet in the html.

setOriginalSheetIndex(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getTargetSheetIndex()

@deprecated. Please use the ’targetSheetIndex’ property instead. Get or set the target index of worksheet where the table is to be located.

getTargetSheetIndex() : number;

setTargetSheetIndex(number)

@deprecated. Please use the ’targetSheetIndex’ property instead. Get or set the target index of worksheet where the table is to be located.

setTargetSheetIndex(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getTableToListObject()

@deprecated. Please use the ’tableToListObject’ property instead. Indicates whether generate list objects from imported table. The default value is false.

getTableToListObject() : boolean;

setTableToListObject(boolean)

@deprecated. Please use the ’tableToListObject’ property instead. Indicates whether generate list objects from imported table. The default value is false.

setTableToListObject(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;