Sets the specified repeat block's data source to a SharePoint List.

<p>public static void SetRepeatBlock(this WordTemplate template, Microsoft.SharePoint.SPList list, System.String bookmark, int maxRows)</p>
<p>Public Shared Sub SetRepeatBlock(ByVal template As WordTemplate, ByVal list As Microsoft.SharePoint.SPList, ByVal bookmark As String, ByVal maxRows As Integer)</p>

The current WordTemplate object calling SetRepeatBlock

The SharePoint List to use as the data source.

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:

  1. Open the template in Microsoft Word.
  2. Open the Edit menu.
  3. Select Go To...
  4. Select Bookmark.
  5. Under Enter bookmark name, open the drop-down list of bookmark names.

Specifies the maximum number of repetitions to write to the file. If Next fields are enabled (see EnableNEXTFields), then the number of rows imported from the data source is maxRows*(numberOfNextFields+1). If Next fields are not enabled the number of rows imported is equal to the number of repetitions written out. To write the maximum rows available, use the constant WordTemplate.ALL_ROWS.

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

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 several times for a single instance of WordTemplate. The repeat block specified by the parameter bookmark must exist in the template.

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


          //--- 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
          //--- Set MaxRows to 10.  Only 10 rows from the SharePoint List
          //--- will be imported
          oWW.SetRepeatBlock(myList, "Page", 10);
          oWW.Process();
        

          '--- 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
          '--- Set MaxRows to 10.  Only 10 rows from the SharePoint List
          '--- will be imported
          oWW.SetRepeatBlock(myList, "Page", 10)
          oWW.Process()