WorksheetExtensions.Import(Worksheet, IDataReader, Boolean, Int32, Int32, DataImportOptions) Method

Imports data from a relational database.

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.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

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

VB.NET

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

Parameters

Name	Type	Description
sheet	Worksheet	A Worksheet that is the worksheet to which the data is imported.
source	IDataReader	An object that exposes the IDataReader interface, e.g., an object returned by the SqlCommand.ExecuteReader method.
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.
options	DataImportOptions	A DataImportOptions object containing data import options, parameters and converter.

Remarks

Use the Import method overload to import data from .NET Framework data providers that access relational databases, such as MS SQL Server, and convert data as required before insertion in a worksheet.