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
Wiki Markup
{introducedin:7.1.0.1855}
{description}
{excerpt}Sets a SharePoint List as a data source for a single row in a template.{excerpt}
{signature:C#}
public static void BindRowData(this ExcelTemplate template, Microsoft.SharePoint.SPList list, String dataSourceName, DataBindingProperties properties)
{signature}{signature:vb.net}
Public Shared Sub BindRowData(ByVal template As ExcelTemplate, 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 BindRowData{param}
{param:list}SharePoint List to use as a data source for the template{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}{{BindRowData}} will throw this exception if {{null}} \(C\#\) or {{Nothing}} \(VB.NET\) is passed to the method.{exception}
{exception:ArgumentException}{exception}
{remarks}
{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}