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:4.1.0.1379}
{description}
{excerpt}Sets the specified repeat block's data source to a SharePoint List. 
{excerpt}
{signature:C#}
public static void SetRepeatBlock(this WordTemplate template, Microsoft.SharePoint.SPList list, System.String bookmark)
{signature}
{signature:vb.net}
Public Shared Sub SetRepeatBlock(ByVal template As WordTemplate, ByVal list As Microsoft.SharePoint.SPList, ByVal bookmark As String)
{signature}
{parameters}
{param:template}The current WordTemplate object calling SetRepeatBlock{param}
{param:list}The SharePoint List to use as the data source.
{param}
{param:bookmark}The bookmark name of the template repeat block. The bookmark passed to {{SetRepeatBlock}} must exist in the template Word file. To see a list of template bookmark names: 
# Open the template in Microsoft Word.
# Open the *Edit* menu.
# Select *Go To...*
# Select *Bookmark*.
# Under *Enter bookmark name*, open the drop\-down list of bookmark names.
{param}
{exceptions}
{exception:ArgumentNullException}{{SetRepeatBlock}} will throw this exception if {{null}} \(C\#\) or {{Nothing}} \(VB.NET\) is passed to the method.
{exception}
{exception:ArgumentException}
{exception}
{remarks}
A repeat block is a fragment in the template document that will be repeated for each row in a data source. In the template document, repeat blocks are defined by Word bookmarks that contain merge fields.

You can call [SetRepeatBlock|WordTemplate.SetRepeatBlock] several times for a single instance of [WordTemplate]. The repeat block specified by the parameter {{bookmark}} must exist in the template.
{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#}

          //--- Set a data source for the repeat block
          //--- defined by the bookmark "Page"
          //--- "myList" is the SharePoint List containing the data to be
          //--- imported and repeated in the repeat block
          oWW.SetRepeatBlock(myList, "Page");
          oWW.Process();
        {code}
{code:vb.net|title=vb.net}

          '--- Set a data source for the repeat block
          '--- defined by the bookmark "Page"
          '--- "myList" is the SharePoint List containing the data to be
          '--- imported and repeated in the repeat block
          oWW.SetRepeatBlock(myList, "Page")
          oWW.Process()
        {code}

{example}