The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+
Row

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

Imports data from a relational database.

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

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Docs.v19.2.dll

Declaration

public static void Import(
    this Worksheet sheet,
    IDataReader source,
    bool addHeader,
    int firstRowIndex,
    int firstColumnIndex
)
<ExtensionAttribute>
Public Shared Sub Import(
    sheet As Worksheet,
    source As IDataReader,
    addHeader As Boolean,
    firstRowIndex As Integer,
    firstColumnIndex As Integer
)
public static void Import(
    this Worksheet sheet,
    IDataReader source,
    bool addHeader,
    int firstRowIndex,
    int firstColumnIndex
)
<ExtensionAttribute>
Public Shared Sub Import(
    sheet As Worksheet,
    source As IDataReader,
    addHeader As Boolean,
    firstRowIndex As Integer,
    firstColumnIndex As Integer
)
public static void Import(
    this Worksheet sheet,
    IDataReader source,
    bool addHeader,
    int firstRowIndex,
    int firstColumnIndex
)
<ExtensionAttribute>
Public Shared Sub Import(
    sheet As Worksheet,
    source As IDataReader,
    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 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.

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.

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.

Remarks

Use the Import method overload to import data from .NET Framework data providers that access relational databases, such as MS SQL Server.

See Also