WorksheetExtensions.Import(Worksheet, DataTable, Boolean, Int32, Int32) Method

Imports data from a data table.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Docs.v24.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public static void Import(
    this Worksheet sheet,
    DataTable source,
    bool addHeader,
    int firstRowIndex,
    int firstColumnIndex
)

VB.NET

<ExtensionAttribute>
Public Shared Sub Import(
    sheet As Worksheet,
    source As DataTable,
    addHeader As Boolean,
    firstRowIndex As Integer,
    firstColumnIndex As Integer
)

Parameters

Name	Type	Description
sheet	Worksheet	A Worksheet that is the worksheet to which the data is imported.
source	DataTable	A DataTable object that is the data source for import.
addHeader	Boolean	true, to insert column names to the row above the cells containing imported data; otherwise, false.
firstRowIndex	Int32	An integer that is the row index of the start cell in which the imported data will be inserted.
firstColumnIndex	Int32	An integer that is the column index of the start cell in which the imported data will be inserted.

Remarks

The following code illustrates how to import data from a DataTable object to a worksheet. Note that the cell data types are set automatically, according to the data types of the source column. Cell formats are set automatically to the default value for the cell data type. However, you can easily change them, as described in the How to: Specify Number or Date Format for Cell Content topic.

View Example

Form1.vb

Private Sub ImportDataTable()

    Dim worksheet As Worksheet = spreadsheetControl1.Document.Worksheets(0)

    ' Create a "Products" DataTable object with four columns.
    Dim sourceTable As New DataTable("Products")
    sourceTable.Columns.Add("Product", GetType(String))
    sourceTable.Columns.Add("Price", GetType(Single))
    sourceTable.Columns.Add("Quantity", GetType(Int32))
    sourceTable.Columns.Add("Discount", GetType(Single))

    sourceTable.Rows.Add("Chocolade", 5, 15, 0.03)
    sourceTable.Rows.Add("Konbu", 9, 55, 0.1)
    sourceTable.Rows.Add("Geitost", 15, 70, 0.07)

    ' Import data from the data table into the worksheet and insert it, starting with the B2 cell.
    worksheet.Import(sourceTable, True, 1, 1)
End Sub

Form1.cs

void ImportDataTable() {

    Worksheet worksheet = spreadsheetControl1.Document.Worksheets[0];

    // Create a "Products" DataTable object with four columns.
    DataTable sourceTable = new DataTable("Products");
    sourceTable.Columns.Add("Product", typeof(string));
    sourceTable.Columns.Add("Price", typeof(float));
    sourceTable.Columns.Add("Quantity", typeof(Int32));
    sourceTable.Columns.Add("Discount", typeof(float));

    sourceTable.Rows.Add("Chocolade", 5, 15, 0.03);
    sourceTable.Rows.Add("Konbu", 9, 55, 0.1);
    sourceTable.Rows.Add("Geitost", 15, 70, 0.07);

    // Import data from the data table into the worksheet and insert it, starting with the B2 cell.
    worksheet.Import(sourceTable, true, 1, 1);
}

The image below shows the results.