Page History

Introducedin

	8.6.1
	8.6.1

Description

Excerpt
Sets an IEnumerable<T> as a data source to bind to template data markers.

Signature

	C#
	C#

  public void BindData(System.Collections.Generic.IEnumerable<T> sourcedataSource, System.String dataSourceName, DataBindingProperties property)

Signature

	vb.net
	vb.net


Public Sub BindData(ByVal sourcedataSource As System.Collections.Generic.IEnumerable(Of T), ByVal dataSourceName As String, ByVal [property] As DataBindingProperties)

Parameters

Param

	sourcedataSourcesource
	dataSource

The IEnumerable<T> collection to use as the data source.

...

Param

	property
	property

The DataBindingProperties object which contains information about how the data should be bound to the template. property Must be specified, but the DataBindingProperties need not be set beforehand. To bind data to a template with the default DataBindingProperties, pass in ExcelTemplate.CreateDataBindingProperties() as the property value. Otherwise, use the ExcelTemplate.CreateDataBindingProperties() method to generate a new DataBindingProperties object and set the DataBindingProperties.MaxRows, DataBindingProperties.Transpose, and/or DataBindingProperties.WorksheetName properties for the workbook.

Exceptions

Exception

	ArgumentNullException
	ArgumentNullException

BindData will throw this exception if null (C#) or Nothing (VB.NET) is passed to the method.

Exception

	SARuntimeException
	SARuntimeException

BindData will throw this exception if the data source contains more rows than the worksheet can hold.
If there is more than one data marker referring to a data source and the data source is forward only, the exception will be thrown only if the source is larger than all bindings can hold.

Exception

Remarks
ArgumentException	ArgumentException
You can set several data sources for a single template. Use the following methods to set template data sources: BindCellData, BindColumnData, BindRowData, and BindData.

Example

Code Block

	csharp
	csharp
title	C#

            ExcelTemplate xlt = new ExcelTemplate();

          interface IOrder
          {
               int OrderID;
               string Customer;
               DateTime OrderDate;
               float OrdersTotal;
          }


          IEnumerable<IOrder> orders = GetOrders();
          xlt.BindData(orders, "Orders", xlt.CreateDataImportProperties());

Code Block

	vb.net
	vb.net
title	vb.net

            Dim xlt As New ExcelTemplate()
          Interface IOrder
               DimProperty OrderID() as Int32
               DimProperty Customer() as String
               DimProperty OrderDate() as DateTime
               DimProperty OrdersTotal() as Single
          End Interface

          Dim orders as IEnumerable(Of Order) = GetOrders()
          xlt.BindData(orders, "Orders", xlt.CreateDataImportProperties())

Space Shortcuts

Page tree

Versions Compared

Old Version 3

New Version Current

Key