Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Introducedin
7.1.0.1855
7.1.0.1855
Description

Excerpt

Sets a SharePoint View as a template data source.

Signature
C#
C#
public static void BindData(this ExcelTemplate template, Microsoft.SharePoint.SPView view, Microsoft.SharePoint.SPList list, String dataSourceName, DataBindingProperties properties)
Signature
vb.net
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)
Parameters
Param
template
template

The current ExcelTemplate object which is calling BindData

Param
view
view

SharePoint View to use as a data source for the template.

Param
list
list

SharePoint List associated with the SharePoint View

Param
dataSourceName
dataSourceName

Name of the data source in the template.

Param
properties
properties

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
ArgumentException
ArgumentException

Remarks

You can set several data sources for a single template. Use the following methods to set template data sources: BindCellData, BindColumnData, BindRowData, and 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