ImportTableOptions

ImportTableOptions class

Represents the options of importing data into cells.

class ImportTableOptions;

Constructors

Name	Description
constructor()	Creates the default importing options.

Methods

Method	Description
getConvertGridStyle()	Indicates whether apply the style of the grid view to cells.
setConvertGridStyle(boolean)	Indicates whether apply the style of the grid view to cells.
getConvertNumericData()	Gets or sets a value that indicates whether the string value should be converted to numeric or date value.
setConvertNumericData(boolean)	Gets or sets a value that indicates whether the string value should be converted to numeric or date value.
getInsertRows()	Indicates whether new rows should be added for importing data records.
setInsertRows(boolean)	Indicates whether new rows should be added for importing data records.
getShiftFirstRowDown()	Indicates whether shifting the first row down when inserting rows.
setShiftFirstRowDown(boolean)	Indicates whether shifting the first row down when inserting rows.
isFieldNameShown()	Indicates whether field name should be imported.
setIsFieldNameShown(boolean)	Indicates whether field name should be imported.
getExportCaptionAsFieldName()	Indicates whether exporting caption as field name
setExportCaptionAsFieldName(boolean)	Indicates whether exporting caption as field name
getDateFormat()	Gets or sets date format string for cells with imported datetime values.
setDateFormat(string)	Gets or sets date format string for cells with imported datetime values.
getNumberFormats()	Gets or sets the number formats
setNumberFormats(string[])	Gets or sets the number formats
getIsFormulas()	Indicates whether the data are formulas.
setIsFormulas(boolean[])	Indicates whether the data are formulas.
getTotalRows()	Gets or sets total row count to import from data source. -1 means all rows of given data source.
setTotalRows(number)	Gets or sets total row count to import from data source. -1 means all rows of given data source.
getTotalColumns()	Gets or sets total column count to import from data source. -1 means all rows of given data source.
setTotalColumns(number)	Gets or sets total column count to import from data source. -1 means all rows of given data source.
getColumnIndexes()	Gets or sets the columns(0-based) to import from data source. null means all columns should be imported.
setColumnIndexes(number[])	Gets or sets the columns(0-based) to import from data source. null means all columns should be imported.
isHtmlString()	Indicates whether the value contains html tags.
setIsHtmlString(boolean)	Indicates whether the value contains html tags.
getCheckMergedCells()	Indicates whether checking merged cells.
setCheckMergedCells(boolean)	Indicates whether checking merged cells.

constructor()

Creates the default importing options.

constructor();

getConvertGridStyle()

Indicates whether apply the style of the grid view to cells.

getConvertGridStyle() : boolean;

setConvertGridStyle(boolean)

Indicates whether apply the style of the grid view to cells.

setConvertGridStyle(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getConvertNumericData()

Gets or sets a value that indicates whether the string value should be converted to numeric or date value.

getConvertNumericData() : boolean;

setConvertNumericData(boolean)

Gets or sets a value that indicates whether the string value should be converted to numeric or date value.

setConvertNumericData(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getInsertRows()

Indicates whether new rows should be added for importing data records.

getInsertRows() : boolean;

setInsertRows(boolean)

Indicates whether new rows should be added for importing data records.

setInsertRows(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShiftFirstRowDown()

Indicates whether shifting the first row down when inserting rows.

getShiftFirstRowDown() : boolean;

setShiftFirstRowDown(boolean)

Indicates whether shifting the first row down when inserting rows.

setShiftFirstRowDown(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isFieldNameShown()

Indicates whether field name should be imported.

isFieldNameShown() : boolean;

setIsFieldNameShown(boolean)

Indicates whether field name should be imported.

setIsFieldNameShown(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getExportCaptionAsFieldName()

Indicates whether exporting caption as field name

getExportCaptionAsFieldName() : boolean;

Remarks

Only works for DataTable.

setExportCaptionAsFieldName(boolean)

Indicates whether exporting caption as field name

setExportCaptionAsFieldName(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only works for DataTable.

getDateFormat()

Gets or sets date format string for cells with imported datetime values.

getDateFormat() : string;

setDateFormat(string)

Gets or sets date format string for cells with imported datetime values.

setDateFormat(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getNumberFormats()

Gets or sets the number formats

getNumberFormats() : string[];

Returns

string[]

setNumberFormats(string[])

Gets or sets the number formats

setNumberFormats(value: string[]) : void;

Parameters:

Parameter	Type	Description
value	string[]	The value to set.

getIsFormulas()

Indicates whether the data are formulas.

getIsFormulas() : boolean[];

Returns

boolean[]

setIsFormulas(boolean[])

Indicates whether the data are formulas.

setIsFormulas(value: boolean[]) : void;

Parameters:

Parameter	Type	Description
value	boolean[]	The value to set.

getTotalRows()

Gets or sets total row count to import from data source. -1 means all rows of given data source.

getTotalRows() : number;

setTotalRows(number)

Gets or sets total row count to import from data source. -1 means all rows of given data source.

setTotalRows(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getTotalColumns()

Gets or sets total column count to import from data source. -1 means all rows of given data source.

getTotalColumns() : number;

setTotalColumns(number)

Gets or sets total column count to import from data source. -1 means all rows of given data source.

setTotalColumns(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getColumnIndexes()

Gets or sets the columns(0-based) to import from data source. null means all columns should be imported.

getColumnIndexes() : number[];

Returns

number[]

setColumnIndexes(number[])

Gets or sets the columns(0-based) to import from data source. null means all columns should be imported.

setColumnIndexes(value: number[]) : void;

Parameters:

Parameter	Type	Description
value	number[]	The value to set.

isHtmlString()

Indicates whether the value contains html tags.

isHtmlString() : boolean;

setIsHtmlString(boolean)

Indicates whether the value contains html tags.

setIsHtmlString(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getCheckMergedCells()

Indicates whether checking merged cells.

getCheckMergedCells() : boolean;

setCheckMergedCells(boolean)

Indicates whether checking merged cells.

setCheckMergedCells(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.