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 the specified Area. 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, DataImportProperties props)
{signature}{signature:
}
Signature
vb.net
vb.net
Public Function ImportData(ByVal data As Object(,), ByVal columnNames As String(), 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 [

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} {param:columnNames}A string array of column names.{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}} object representing the set of cells populated with the imported values.{returns} {example}{code:csharp|title=C#}

Param
columnNames
columnNames

A string array of column names.

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#


DataImportProperties importProps = wb.CreateDataImportProperties();
importProps.Transpose = true;
Area importedArea = a.ImportData(dataArray, fieldNames, importProps);
{code} {code:vbnet|title=
Code Block
vbnet
vbnet
titlevb.net
}


Dim importProps As DataImportProperties = wb.CreateDataImportProperties()
importProps.Transpose = True
Dim importedArea As Area = a.ImportData(dataArray, fieldNames, importProps)
{code} {example} {scrollbar}
Scrollbar