WorksheetExtensions.Import(Worksheet, Object, Int32, Int32, DataSourceImportOptions) Method

Imports data from a data source.

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

Declaration

C#

public static void Import(
    this Worksheet sheet,
    object dataSource,
    int firstRowIndex,
    int firstColumnIndex,
    DataSourceImportOptions options
)

VB.NET

<ExtensionAttribute>
Public Shared Sub Import(
    sheet As Worksheet,
    dataSource As Object,
    firstRowIndex As Integer,
    firstColumnIndex As Integer,
    options As DataSourceImportOptions
)

Parameters

Name	Type	Description
sheet	Worksheet	A Worksheet that is the worksheet to which the data is imported.
dataSource	Object	An object that is the data source for import.
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	DataSourceImportOptions	A DataSourceImportOptions object specifying filed names to import.

Remarks

You can specify object properties to import, as illustrated in the following code snippet..

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-import-data-to-worksheet-cells-from-different-data-sources-and-use-tables-e4751

Form1.vb

Dim list As New List(Of TestObject)()
list.Add(New TestObject(1, "1", True))
list.Add(New TestObject(2, "2", False))
worksheet.Import(list, 0, 0, New DataSourceImportOptions() With {
    .PropertyNames = New String() { "BoolValue", "IntValue" }
})

TestObject.vb

Friend Class TestObject
    Public Sub New(ByVal intValue As Integer, ByVal value As String, ByVal boolValue As Boolean)
        Me.intValue_Renamed = intValue
        Me.Value = value
        Me.BoolValue = boolValue

    End Sub
    Public intValue_Renamed As Integer
    Private ReadOnly Property privateValue() As Integer
        Get
            Return 123
        End Get
    End Property
    Public ReadOnly Property IntValue() As Integer
        Get
            Return intValue_Renamed + privateValue - 123
        End Get
    End Property
    Public Property Value() As String
    Public Property BoolValue() As Boolean
    Default Public ReadOnly Property Item(ByVal index As Integer) As Integer
        Get
            Return index
        End Get
    End Property
End Class

Form1.cs

List<TestObject> list = new List<TestObject>();
list.Add(new TestObject(1, "1", true));
list.Add(new TestObject(2, "2", false));
worksheet.Import(list, 0, 0, new DataSourceImportOptions() { PropertyNames = new string[] { "BoolValue", "IntValue" } });

TestObject.cs

class TestObject
{
    public TestObject(int intValue, string value, bool boolValue)
    {
        this.intValue = intValue;
        this.Value = value;
        this.BoolValue = boolValue;

    }
    public int intValue;
    private int privateValue { get { return 123; } }
    public int IntValue { get { return intValue + privateValue - 123; } }
    public string Value { get; set; }
    public bool BoolValue { get; set; }
    public int this[int index] { get { return index; } }
}