GrapeCity.Documents.Excel.DataImportOptions

Class DataImportOptions

Namespace

GrapeCity.Documents.Excel

Assembly

GcDocs.Excel.dll

The options for importing data to a range.

public class DataImportOptions

Inheritance

object

DataImportOptions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

DataImportOptions()

public DataImportOptions()

Properties

ColumnsSelector

Selects columns to import. The default behavior is to auto-generate all columns.

public Func<object, IEnumerable> ColumnsSelector { get; set; }

Property Value

Func<object, IEnumerable>

The delegate accepts the collection or DataTable to select columns.
The delegate returns different types of values to describe selected columns:

• Returns IEnumerable<T> of DataColumn to select columns for the specified DataTable.
• Returns IEnumerable<T> of int to select columns by indexes for the specified DataTable.
• Returns IEnumerable<T> of string to select columns by names for the specified DataTable, dictionary or custom object. This option is not AOT-compatible for custom objects.
• Returns IEnumerable<T> of property getter Delegate (where the delegate type of each element is Func<T, TResult>, T is the element type of collection, TResult is the property type) to select columns with custom column getters.
  In this case, IncludeColumnsHeader must be false. Otherwise, an exception will be thrown. Because we don't know the column names.
• Returns IEnumerable<T> of named property getter (T1, T2) (where T1 is column name string, T2 is property getter Delegate; The delegate type of each element is Func<T, TResult>, T is the element type of collection, TResult is the property type) to select columns with custom column names and custom column getters.
  In this case, IncludeColumnsHeader should be true. Otherwise, the column names will be ignored.

Remarks

The default behavior is not AOT-compatible for custom objects.

IncludeColumnsHeader

Determines whether to include column header as the first row when importing data.

public bool IncludeColumnsHeader { get; set; }

Property Value

bool

The default value is true.

InsufficientSpaceHandling

Determines how to handle insufficient space when importing data.

public InsufficientSpaceHandling InsufficientSpaceHandling { get; set; }

Property Value

InsufficientSpaceHandling

The default value is Overwrite.

ItemTypeProvider

Gets item type from the specified IEnumerable. The type is used to generate columns. The default behavior is to try to get the item type from the generic parameter of IEnumerable<T>, then try to get type from the first item of the IEnumerable.

public Func<IEnumerable, Type> ItemTypeProvider { get; set; }

Property Value

Func<IEnumerable, Type>

The delegate accepts the IEnumerable for getting element type.
The delegate returns the item type of the IEnumerable.