Back to Devexpress

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

officefileapi-devexpress-dot-spreadsheet-dot-worksheetextensions-dot-import-x28-devexpress-dot-spreadsheet-dot-worksheet-system-dot-collections-dot-ienumerable-system-dot-int32-system-dot-int32-system-dot-boolean-x29.md

latest3.9 KB
Original Source

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

Imports data from a collection.

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

NuGet Package : DevExpress.Document.Processor

Declaration

csharp
public static void Import(
    this Worksheet sheet,
    IEnumerable source,
    int firstRowIndex,
    int firstColumnIndex,
    bool isVertical
)
vb
<ExtensionAttribute>
Public Shared Sub Import(
    sheet As Worksheet,
    source As IEnumerable,
    firstRowIndex As Integer,
    firstColumnIndex As Integer,
    isVertical As Boolean
)

Parameters

NameTypeDescription
sheetWorksheet

A Worksheet that is the worksheet to which the data is imported.

| | source | IEnumerable |

An object that exposes the IEnumerable interface provided by a collection of objects being imported.

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

| | isVertical | Boolean |

true , to insert imported data vertically; otherwise, false

|

Remarks

The following code snippet illustrates how to use the Import method.

View Example

vb
' Create a List object containing string values.
Dim cities As New List(Of String)()
cities.Add("New York")
cities.Add("Rome")
cities.Add("Beijing")
cities.Add("Delhi")

' Import the list into the worksheet and insert it vertically, starting with the B1 cell.
worksheet.Import(cities, 0, 1, True)
csharp
// Create a List object containing string values.
List<string> cities = new List<string>();
cities.Add("New York");
cities.Add("Rome");
cities.Add("Beijing");
cities.Add("Delhi");

// Import the list into the worksheet and insert it vertically, starting with the B1 cell.
worksheet.Import(cities, 0, 1, true);

The image below shows the results.

See Also

How to: Import Data to a Worksheet in SpreadsheetControl for WinForms

WorksheetExtensions Class

WorksheetExtensions Members

DevExpress.Spreadsheet Namespace