Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Description

Excerpt

Imports data from a rectangular array of objects to cells in the worksheet. The new data will overwrite values and formulas in the target worksheet cells, but existing formatting will be preserved.

Signature
C#
C#
 public Area ImportData(System.Object[,] data, System.String[] columnNames, Cell cell, DataImportProperties props)
{signature}{signature:
}
Signature
vb.net
vb.net
Public Function ImportData(ByVal data As Object(,), ByVal columnNames As String(), ByVal cell As Cell, ByVal props As DataImportProperties) As Area
{signature}
{parameters}
{param:data}A rectangular array of values to import to the worksheet. The first dimension corresponds to row and the second to column.
        Thus, an array of data  \{ \
Parameters
Param
data
data

A rectangular array of values to import to the worksheet. The first dimension corresponds to row and the second to column.
Thus, an array of data { {"A","X"

\

},

\

{"B","Y"

\

},

\

{"C","Z"

\

}

\

}

would

be

inserted

into

the

worksheet

as:

|A|X| |B|Y| |C|Z| If you enable [DataImportProperties.Transpose|DataImportProperties.Transpose] , the format will be \[row\]\[column\], so: \{ \

A

X

B

Y

C

Z

If you enable DataImportProperties.Transpose , the format will be [row][column], so:
{ {"A","B","C"

\

},

\

{"X","Y","Z"

\

}

\

}

would

be

inserted

into

the

worksheet

as:

\|


A

|

X

| |

B

|

Y

| |

C

|

Z

| {param} {param:columnNames}An array of column names for the imported data. {{columnNames}} and the column dimension of {{data}} must contain the same number of elements.{param} {param:startCell}The cell at which to start entering the imported values.{param} {param:props}A [DataImportProperties|DataImportProperties] object that contains a set of properties that will determine the behavior of the data import.{param} {returns}An [Area|Area] object representing the set of cells populated with the imported values.{returns} {example}{code:csharp|title=C#}

Param
columnNames
columnNames

An array of column names for the imported data. columnNames and the column dimension of data must contain the same number of elements.

Param
startCell
startCell

The cell at which to start entering the imported values.

Param
props
props

A DataImportProperties object that contains a set of properties that will determine the behavior of the data import.

Returns

An Area object representing the set of cells populated with the imported values.

Example
Code Block
csharp
csharp
titleC#

Area importedArea = ws.ImportData(dataArray, fieldNames, cel, importProps);
{code} {code:
Code Block
vb.net
|title=
vb.net
titlevb.net
}

Dim importedArea As Area = ws.ImportData(dataArray, fieldNames, cel, importProps)
{code} {example}