GrapeCity.Documents.Excel.IRange.ImportData

ImportData Method

ImportData(IEnumerable, DataImportOptions)

Imports data from a data source (up to 2D) to the range.

Declaration

DataImportResult ImportData(IEnumerable items, DataImportOptions options = null)

Function ImportData(items As IEnumerable, Optional options As DataImportOptions = Nothing) As DataImportResult

Parameters

Type	Name	Description
IEnumerable	items	The items to import. The element type can be: Primitive types: sbyte, byte, short, ushort, int, uint, long, ulong, float, double, decimal, bool, DateTime, TimeSpan or CalcError. Nullable primitives: string or Nullable<T> where T is a primitive type. Custom objects: objects that have properties to be mapped to cell values. IReadOnlyDictionary<TKey, TValue> or IDictionary<TKey, TValue> or IDictionary where the key is string: It will be treated as collection of property names and values. DataRow or DataRowView. The collection type can be: Flat (non-jagged, 1D in total) IEnumerable. For example, DataView. Jagged (2D in total) IEnumerable or IEnumerable<T> where the element type of inner collection is primitive or nullable primitive. 2D array where element type is primitive or nullable primitive. If the item collection is a list of primitive types, the orientation is determined by the shape of range. If the row count of the range is greater than column count, we import the collection vertically. Otherwise, we import the collection horizontally.
DataImportOptions	options	The import options.

Type

Name

Description

IEnumerable

items

The items to import. The element type can be:

Primitive types: sbyte, byte, short, ushort, int, uint, long, ulong, float, double, decimal, bool, DateTime, TimeSpan or CalcError.
Nullable primitives: string or Nullable<T> where T is a primitive type.
Custom objects: objects that have properties to be mapped to cell values.
IReadOnlyDictionary<TKey, TValue> or IDictionary<TKey, TValue> or IDictionary where the key is string: It will be treated as collection of property names and values.
DataRow or DataRowView.

The collection type can be:

Flat (non-jagged, 1D in total) IEnumerable. For example, DataView.
Jagged (2D in total) IEnumerable or IEnumerable<T> where the element type of inner collection is primitive or nullable primitive.
2D array where element type is primitive or nullable primitive.

If the item collection is a list of primitive types, the orientation is determined by the shape of range. If the row count of the range is greater than column count, we import the collection vertically. Otherwise, we import the collection horizontally.

DataImportOptions

options

The import options.

Returns

Type	Description
DataImportResult	A DataImportResult that describes the imported rows and columns.

Examples

Dictionary<string, object> item = new Dictionary<string, object>();
item["Name"] = "Alice";
item["Score"] = 95;
DataImportOptions options = new DataImportOptions();
options.ColumnsSelector = source => new string[] {"Name"};
DataImportResult result = worksheet.Range["A1"].ImportData(new[] {item}, options);
int columnsImported = result.ColumnsImported;

Exceptions

Type	Condition
InvalidCastException	The data type of a column is inconsistent. Use ItemTypeProvider to fix it.
ArgumentException	An item is of an unsupported type or `options` contains incorrect information.
NotSupportedException	It's typically thrown when AOT compatibility issues occur at runtime.

ImportData<T>(IEnumerable<T>, DataImportOptions)

Imports data from a data source (up to 2D) to the range.

Declaration

DataImportResult ImportData<T>(IEnumerable<T> items, DataImportOptions options = null)

Function ImportData(Of T)(items As IEnumerable(Of T), Optional options As DataImportOptions = Nothing) As DataImportResult

Parameters

Type	Name	Description
IEnumerable<T>	items	The items to import. The element type can be: Primitive types: sbyte, byte, short, ushort, int, uint, long, ulong, float, double, decimal, bool, DateTime, TimeSpan or CalcError. Nullable primitives: string or Nullable<T> where T is a primitive type. Custom objects: objects that have properties to be mapped to cell values. IReadOnlyDictionary<TKey, TValue> or IDictionary<TKey, TValue> or IDictionary where the key is string: It will be treated as collection of property names and values. DataRow or DataRowView. The collection type can be: Flat (non-jagged, 1D in total) IEnumerable<T>. Jagged (2D in total) IEnumerable<T> where the element type of inner collection is primitive or nullable primitive. 2D array where element type is primitive or nullable primitive. If the item collection is a list of primitive types, the orientation is determined by the shape of range. If the row count of the range is greater than column count, we import the collection vertically. Otherwise, we import the collection horizontally.
DataImportOptions	options	The import options.

Type

Name

Description

IEnumerable<T>

items

The items to import. The element type can be:

Primitive types: sbyte, byte, short, ushort, int, uint, long, ulong, float, double, decimal, bool, DateTime, TimeSpan or CalcError.
Nullable primitives: string or Nullable<T> where T is a primitive type.
Custom objects: objects that have properties to be mapped to cell values.
IReadOnlyDictionary<TKey, TValue> or IDictionary<TKey, TValue> or IDictionary where the key is string: It will be treated as collection of property names and values.
DataRow or DataRowView.

The collection type can be:

Flat (non-jagged, 1D in total) IEnumerable<T>.
Jagged (2D in total) IEnumerable<T> where the element type of inner collection is primitive or nullable primitive.
2D array where element type is primitive or nullable primitive.

DataImportOptions

options

The import options.

Returns

Type	Description
DataImportResult

Type Parameters

Name	Description
T

Examples

var items = new[] {new SalesRecord { Name = "Alice", Score = 95 }};
DataImportResult result = worksheet.Range["A1"].ImportData(items);
int rowsImported = result.RowsImported;

Exceptions

Type	Condition
InvalidCastException	The data type of a column is inconsistent. Check whether the implementation of ItemTypeProvider is correct.
ArgumentException	An item is of an unsupported type or `options` contains incorrect information.
NotSupportedException	It's typically thrown when AOT compatibility issues occur at runtime.

ImportData(DataTable, DataImportOptions)

Imports data from a table to the range.

Declaration

DataImportResult ImportData(DataTable table, DataImportOptions options = null)

Function ImportData(table As DataTable, Optional options As DataImportOptions = Nothing) As DataImportResult

Parameters

Type	Name	Description
DataTable	table	The table to import. The column type can be: Primitive types: sbyte, byte, short, ushort, int, uint, long, ulong, float, double, decimal, bool, DateTime, TimeSpan or CalcError. Nullable primitives: string or Nullable<T> where T is a primitive type.
DataImportOptions	options	The import options.

Type

Name

Description

DataTable

table

The table to import. The column type can be:

Primitive types: sbyte, byte, short, ushort, int, uint, long, ulong, float, double, decimal, bool, DateTime, TimeSpan or CalcError.
Nullable primitives: string or Nullable<T> where T is a primitive type.

DataImportOptions

options

The import options.

Returns

Type	Description
DataImportResult	A DataImportResult that describes the imported rows and columns.

Examples

DataTable table = new DataTable();
table.Columns.Add("Name", typeof(string));
table.Columns.Add("Score", typeof(int));
table.Rows.Add("Alice", 95);
DataImportOptions options = new DataImportOptions();
options.IncludeColumnsHeader = true;
DataImportResult result = worksheet.Range["A1"].ImportData(table, options);
int columnsImported = result.ColumnsImported;

Exceptions

Type	Condition
InvalidCastException	The data type of a column is inconsistent.
ArgumentException	`options` contains incorrect information.
NotSupportedException	It's typically thrown when AOT compatibility issues occur at runtime.