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
4.1.0.1379
4.1.0.1379
Description

Excerpt

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

Signature
C#
C#
<p>public static void SetRepeatBlock(this WordTemplate template, Microsoft.SharePoint.SPView view, Microsoft.SharePoint.SPList list, string bookmark)</p>
Signature
vb.net
vb.net
<p>Public Shared Sub SetRepeatBlock(ByVal template As WordTemplate, ByVal view As Microsoft.SharePoint.SPView, ByVal list As Microsoft.SharePoint.SPList, ByVal bookmark As String)</p>
Parameters
Param
template
template

The current WordTemplate object calling SetRepeatBlock

Param
view
view

The SharePoint View to use as the data source.

Param
list
list

The SharePoint List to which the View applies.

Param
bookmark
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:

  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.
Exceptions
Exception
ArgumentNullException
ArgumentNullException

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

Exception
ArgumentException
ArgumentException

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

Example
Code Block
csharp
csharp
titleC#

          //--- Set a data source for the repeat block
          //--- defined by the bookmark "Page"
          //--- "myView" is the SharePoint View containing the data to be
          //--- imported and repeated in the repeat block
          oWW.SetRepeatBlock(myView, myList, "Page");
          oWW.Process();
        
Code Block
vb.net
vb.net
titlevb.net

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