ImportTableOptions

ImportTableOptions class

Represents the options of importing data into cells.

class ImportTableOptions;

Constructors

Constructor	Description
constructor()	Creates the default importing options.

Properties

Property	Type	Description
convertGridStyle	boolean	Indicates whether apply the style of the grid view to cells.
convertNumericData	boolean	Gets or sets a value that indicates whether the string value should be converted to numeric or date value.
insertRows	boolean	Indicates whether new rows should be added for importing data records.
shiftFirstRowDown	boolean	Indicates whether shifting the first row down when inserting rows.
isFieldNameShown	boolean	Indicates whether field name should be imported.
exportCaptionAsFieldName	boolean	Indicates whether exporting caption as field name
dateFormat	string	Gets or sets date format string for cells with imported datetime values.
numberFormats	string[]	Gets or sets the number formats
isFormulas	boolean[]	Indicates whether the data are formulas.
totalRows	number	Gets or sets total row count to import from data source. -1 means all rows of given data source.
totalColumns	number	Gets or sets total column count to import from data source. -1 means all rows of given data source.
columnIndexes	number[]	Gets or sets the columns(0-based) to import from data source. null means all columns should be imported.
defaultValues	Object[]	Default value for the value in the table is null.
isHtmlString	boolean	Indicates whether the value contains html tags.
checkMergedCells	boolean	Indicates whether checking merged cells.

Methods

Method	Description
getConvertGridStyle()	@deprecated. Please use the ‘convertGridStyle’ property instead. Indicates whether apply the style of the grid view to cells.
setConvertGridStyle(boolean)	@deprecated. Please use the ‘convertGridStyle’ property instead. Indicates whether apply the style of the grid view to cells.
getConvertNumericData()	@deprecated. Please use the ‘convertNumericData’ property instead. Gets or sets a value that indicates whether the string value should be converted to numeric or date value.
setConvertNumericData(boolean)	@deprecated. Please use the ‘convertNumericData’ property instead. Gets or sets a value that indicates whether the string value should be converted to numeric or date value.
getInsertRows()	@deprecated. Please use the ‘insertRows’ property instead. Indicates whether new rows should be added for importing data records.
setInsertRows(boolean)	@deprecated. Please use the ‘insertRows’ property instead. Indicates whether new rows should be added for importing data records.
getShiftFirstRowDown()	@deprecated. Please use the ‘shiftFirstRowDown’ property instead. Indicates whether shifting the first row down when inserting rows.
setShiftFirstRowDown(boolean)	@deprecated. Please use the ‘shiftFirstRowDown’ property instead. Indicates whether shifting the first row down when inserting rows.
isFieldNameShown()	@deprecated. Please use the ‘isFieldNameShown’ property instead. Indicates whether field name should be imported.
setIsFieldNameShown(boolean)	@deprecated. Please use the ‘isFieldNameShown’ property instead. Indicates whether field name should be imported.
getExportCaptionAsFieldName()	@deprecated. Please use the ’exportCaptionAsFieldName’ property instead. Indicates whether exporting caption as field name
setExportCaptionAsFieldName(boolean)	@deprecated. Please use the ’exportCaptionAsFieldName’ property instead. Indicates whether exporting caption as field name
getDateFormat()	@deprecated. Please use the ‘dateFormat’ property instead. Gets or sets date format string for cells with imported datetime values.
setDateFormat(string)	@deprecated. Please use the ‘dateFormat’ property instead. Gets or sets date format string for cells with imported datetime values.
getNumberFormats()	@deprecated. Please use the ’numberFormats’ property instead. Gets or sets the number formats
setNumberFormats(string[])	@deprecated. Please use the ’numberFormats’ property instead. Gets or sets the number formats
getIsFormulas()	@deprecated. Please use the ‘isFormulas’ property instead. Indicates whether the data are formulas.
setIsFormulas(boolean[])	@deprecated. Please use the ‘isFormulas’ property instead. Indicates whether the data are formulas.
getTotalRows()	@deprecated. Please use the ’totalRows’ property instead. Gets or sets total row count to import from data source. -1 means all rows of given data source.
setTotalRows(number)	@deprecated. Please use the ’totalRows’ property instead. Gets or sets total row count to import from data source. -1 means all rows of given data source.
getTotalColumns()	@deprecated. Please use the ’totalColumns’ property instead. Gets or sets total column count to import from data source. -1 means all rows of given data source.
setTotalColumns(number)	@deprecated. Please use the ’totalColumns’ property instead. Gets or sets total column count to import from data source. -1 means all rows of given data source.
getColumnIndexes()	@deprecated. Please use the ‘columnIndexes’ property instead. Gets or sets the columns(0-based) to import from data source. null means all columns should be imported.
setColumnIndexes(number[])	@deprecated. Please use the ‘columnIndexes’ property instead. Gets or sets the columns(0-based) to import from data source. null means all columns should be imported.
getDefaultValues()	@deprecated. Please use the ‘defaultValues’ property instead. Default value for the value in the table is null.
setDefaultValues(Object[])	@deprecated. Please use the ‘defaultValues’ property instead. Default value for the value in the table is null.
isHtmlString()	@deprecated. Please use the ‘isHtmlString’ property instead. Indicates whether the value contains html tags.
setIsHtmlString(boolean)	@deprecated. Please use the ‘isHtmlString’ property instead. Indicates whether the value contains html tags.
getCheckMergedCells()	@deprecated. Please use the ‘checkMergedCells’ property instead. Indicates whether checking merged cells.
setCheckMergedCells(boolean)	@deprecated. Please use the ‘checkMergedCells’ property instead. Indicates whether checking merged cells.
isNull()	Checks whether the implementation object is null.

constructor()

Creates the default importing options.

constructor();

convertGridStyle

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

convertGridStyle : boolean;

convertNumericData

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

convertNumericData : boolean;

insertRows

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

insertRows : boolean;

shiftFirstRowDown

Indicates whether shifting the first row down when inserting rows.

shiftFirstRowDown : boolean;

isFieldNameShown

Indicates whether field name should be imported.

isFieldNameShown : boolean;

exportCaptionAsFieldName

Indicates whether exporting caption as field name

exportCaptionAsFieldName : boolean;

Remarks

Only works for DataTable.

dateFormat

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

dateFormat : string;

numberFormats

Gets or sets the number formats

numberFormats : string[];

isFormulas

Indicates whether the data are formulas.

isFormulas : boolean[];

totalRows

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

totalRows : number;

totalColumns

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

totalColumns : number;

columnIndexes

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

columnIndexes : number[];

defaultValues

Default value for the value in the table is null.

defaultValues : Object[];

isHtmlString

Indicates whether the value contains html tags.

isHtmlString : boolean;

checkMergedCells

Indicates whether checking merged cells.

checkMergedCells : boolean;

getConvertGridStyle()

@deprecated. Please use the ‘convertGridStyle’ property instead. Indicates whether apply the style of the grid view to cells.

getConvertGridStyle() : boolean;

setConvertGridStyle(boolean)

@deprecated. Please use the ‘convertGridStyle’ property instead. 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()

@deprecated. Please use the ‘convertNumericData’ property instead. Gets or sets a value that indicates whether the string value should be converted to numeric or date value.

getConvertNumericData() : boolean;

setConvertNumericData(boolean)

@deprecated. Please use the ‘convertNumericData’ property instead. 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()

@deprecated. Please use the ‘insertRows’ property instead. Indicates whether new rows should be added for importing data records.

getInsertRows() : boolean;

setInsertRows(boolean)

@deprecated. Please use the ‘insertRows’ property instead. 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()

@deprecated. Please use the ‘shiftFirstRowDown’ property instead. Indicates whether shifting the first row down when inserting rows.

getShiftFirstRowDown() : boolean;

setShiftFirstRowDown(boolean)

@deprecated. Please use the ‘shiftFirstRowDown’ property instead. 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()

@deprecated. Please use the ‘isFieldNameShown’ property instead. Indicates whether field name should be imported.

isFieldNameShown() : boolean;

setIsFieldNameShown(boolean)

@deprecated. Please use the ‘isFieldNameShown’ property instead. Indicates whether field name should be imported.

setIsFieldNameShown(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getExportCaptionAsFieldName()

@deprecated. Please use the ’exportCaptionAsFieldName’ property instead. Indicates whether exporting caption as field name

getExportCaptionAsFieldName() : boolean;

Remarks

Only works for DataTable.

setExportCaptionAsFieldName(boolean)

@deprecated. Please use the ’exportCaptionAsFieldName’ property instead. 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()

@deprecated. Please use the ‘dateFormat’ property instead. Gets or sets date format string for cells with imported datetime values.

getDateFormat() : string;

setDateFormat(string)

@deprecated. Please use the ‘dateFormat’ property instead. 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()

@deprecated. Please use the ’numberFormats’ property instead. Gets or sets the number formats

getNumberFormats() : string[];

Returns

string[]

setNumberFormats(string[])

@deprecated. Please use the ’numberFormats’ property instead. Gets or sets the number formats

setNumberFormats(value: string[]) : void;

Parameters:

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

getIsFormulas()

@deprecated. Please use the ‘isFormulas’ property instead. Indicates whether the data are formulas.

getIsFormulas() : boolean[];

Returns

boolean[]

setIsFormulas(boolean[])

@deprecated. Please use the ‘isFormulas’ property instead. Indicates whether the data are formulas.

setIsFormulas(value: boolean[]) : void;

Parameters:

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

getTotalRows()

@deprecated. Please use the ’totalRows’ property instead. Gets or sets total row count to import from data source. -1 means all rows of given data source.

getTotalRows() : number;

setTotalRows(number)

@deprecated. Please use the ’totalRows’ property instead. 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()

@deprecated. Please use the ’totalColumns’ property instead. Gets or sets total column count to import from data source. -1 means all rows of given data source.

getTotalColumns() : number;

setTotalColumns(number)

@deprecated. Please use the ’totalColumns’ property instead. 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()

@deprecated. Please use the ‘columnIndexes’ property instead. 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[])

@deprecated. Please use the ‘columnIndexes’ property instead. 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.

getDefaultValues()

@deprecated. Please use the ‘defaultValues’ property instead. Default value for the value in the table is null.

getDefaultValues() : Object[];

Returns

Object[]

setDefaultValues(Object[])

@deprecated. Please use the ‘defaultValues’ property instead. Default value for the value in the table is null.

setDefaultValues(value: Object[]) : void;

Parameters:

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

isHtmlString()

@deprecated. Please use the ‘isHtmlString’ property instead. Indicates whether the value contains html tags.

isHtmlString() : boolean;

setIsHtmlString(boolean)

@deprecated. Please use the ‘isHtmlString’ property instead. Indicates whether the value contains html tags.

setIsHtmlString(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getCheckMergedCells()

@deprecated. Please use the ‘checkMergedCells’ property instead. Indicates whether checking merged cells.

getCheckMergedCells() : boolean;

setCheckMergedCells(boolean)

@deprecated. Please use the ‘checkMergedCells’ property instead. Indicates whether checking merged cells.

setCheckMergedCells(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;