Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

...

Wiki Markup
{introducedin:4.1.0.1379

...

Description

Excerpt

Sets a main document data source to a SharePoint List. If the specified List contains more than one row, WordWriter will use the first row as the data source.

Signature
C#C#
}
{description}
{excerpt}Sets a main document data source to a SharePoint List. If the specified List contains more than one row, WordWriter will use the first row as the data source.
{excerpt}
{signature:C#}
public static void SetDataSource(this WordTemplate template, Microsoft.SharePoint.SPList list, string name)
Signature
{signature}
{signature:vb.net
vb.net
}
Public Shared Sub SetDataSource(ByVal template As WordTemplate, ByVal list As Microsoft.SharePoint.SPList, ByVal name As String)
Parameters

...

The current ExcelTemplate which is calling SetDataSource

...

A SharePoint List to use as the data source. WordWriter will use the first row of the List as the data source.

...

Specifies the data source name for the set of merge fields.

Exceptions
This is an extension method for the WordTemplate object to be used for binding SharePoint data to applications from within SharePoint. To use this method, you must add a reference to
{signature}
{parameters}
{param:template}The current ExcelTemplate which is calling SetDataSource{param}
{param:list}A SharePoint List to use as the data source. WordWriter will use the first row of the List as the data source.
{param}
{param:name}Specifies the data source name for the set of merge fields.
{param}
{exceptions}
{exception:ArgumentNullException}[Save|WordTemplate.Save] will throw this exception if {{null}} \(C\#\) or {{Nothing}} \(VB.NET\) is passed to the method.
{exception}
{exception:ArgumentException}
{exception}
{remarks}Each merge field in a WordWriter template must bind to a data source field/value pair. The number of merge fields in the template may not exceed the number of values in the data source. However, the number of values in the data source may be greater than the number of merge fields in the template.

This method may be called once for each set of merge fields in the main document.
{note}This is an extension method for the WordTemplate object to be used for binding SharePoint data to applications from within SharePoint.  To use this method, you must add a reference to SoftArtisans.OfficeWriter.WordWriter.SharePointIntegration.dll
{note}
{remarks}
{example}{code:csharp|title=C#}
          //--- Pass the SPList to SetDataSource.
          oWW.SetDataSource(myList, "Employee");
        
{code}
{code:vb.net
|title=vb.net
}
          '--- Pass the SPList to SetDataSource.
          oWW.SetDataSource(myList, "Employee")
        {code}

{example}
Exception
ArgumentNullExceptionArgumentNullException

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

Exception
ArgumentExceptionArgumentException
Remarks

Each merge field in a WordWriter template must bind to a data source field/value pair. The number of merge fields in the template may not exceed the number of values in the data source. However, the number of values in the data source may be greater than the number of merge fields in the template.

This method may be called once for each set of merge fields in the main document.

Note
Example
Code Block
csharpcsharp
titleC#
Code Block
vb.nettitle