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 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#
Wiki Markup
{description}
{excerpt}Imports data from a rectangular array of objects  to the specified [Area|Area]. 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, 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
Parameters
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
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

Param
columnNamescolumnNames

A string array of column names.

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}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#}

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

Dim importProps As DataImportProperties = wb.CreateDataImportProperties()
importProps.Transpose = True
Dim importedArea As Area = a.ImportData(dataArray, fieldNames, importProps)
Example
Code Block
csharpcsharp
titleC#
Code Block
vbnetvbnettitle

...

{code}

{example}
{scrollbar}