Page History

{introducedin:7.1.0.1855}
{description}
{excerpt}Sets a SharePoint View as a template data source.{excerpt}
{signature:C#}
public static void BindData(this ExcelTemplate template, Microsoft.SharePoint.SPView view, Microsoft.SharePoint.SPList list, String dataSourceName, DataBindingProperties properties)
{signature}{signature:vb.net}
Public Shared Sub BindData(ByVal template As ExcelTemplate, ByVal view As Microsoft.SharePoint.SPView, ByVal list As Microsoft.SharePoint.SPList, ByVal dataSourceName As String, ByVal properties As DataBindingProperties)
{signature}
{parameters}
{param:template}The current ExcelTemplate object which is calling BindData{param}
{param:view}SharePoint View to use as a data source for the template.{param}
{param:list}SharePoint List associated with the SharePoint View{param}
{param:dataSourceName}Name of the data source in the template.{param}
{param:properties}The [DataBindingProperties|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.MaxRows], [DataBindingProperties.Transpose|DataBindingProperties.Transpose], and/or [DataBindingProperties.WorksheetName|DataBindingProperties.WorksheetName] properties for the workbook.{param}
{exceptions}
{exception:ArgumentNullException}{{BindData}} will throw this exception if {{null}} \(C\#\) or {{Nothing}} \(VB.NET\) is passed to the method.{exception}
{exception:ArgumentException}{exception}
{remarks}
You can set several data sources for a single template. Use the following methods to set template data sources: [BindCellData|ExcelTemplate.BindCellData(Object, String, DataBindingProperties)], [BindColumnData|ExcelTemplate.BindColumnData], [BindRowData|ExcelTemplate.BindRowData], and [BindData|ExcelTemplate.BindData].
{note}This is an extension method for the ExcelTemplate object to be used for binding SharePoint data to spreadsheets from within SharePoint.  To use this method, you must add a reference to SoftArtisans.OfficeWriter.ExcelWriter.SharePointIntegration.dll{note}
{remarks}