Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
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#
Wiki Markup
{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.{excerpt}
{signature: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
Parameters
Param
datadataA 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 {
{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  \{ \{"A","X"\},\{"B","Y"\},\{"C","Z"\} \}  would be inserted into the worksheet as:

A

X

B

Y

C

Z

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

        |A|X|
|B|Y|
|C|Z|

        If you enable [DataImportProperties.Transpose|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
columnNamescolumnNames

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

Param
startCellstartCell

The cell at which to start entering the imported values.

Param
propsprops

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.

|
{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#}
Area importedArea = ws.ImportData(dataArray, fieldNames, cel, importProps);
{code}
{code:vb.net
|title=vb.net
}
Dim importedArea As Area = ws.ImportData(dataArray, fieldNames, cel, importProps){code}

{example}
Example
Code Block
csharpcsharp
titleC#
Code Block
vb.nettitle