Page History

...

{description}
{excerpt}Sets the specified repeat block's data source to an

...

 {msdn

...

:System.Collections.IEnumerator

...

|IEnumerator} collection. 
{excerpt}
{signature:C#}
 public void SetRepeatBlock(System.Collections.IEnumerator dataSource, System.String fieldName, System.String bookmark)

{signature}
{signature:vb.net

}
Public Sub SetRepeatBlock(ByVal dataSource As System.Collections.IEnumerator, ByVal fieldName As String, ByVal bookmark As String)

...

An IEnumerator collection to use as the data source.

...

The name of the merge field at which to insert the values.

...

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.

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

...

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. All merge fields in the repeat block will bind to the specified data source.

Not all Word features can be included in a repeat block:

{signature}
{parameters}
{param:dataSource}An {{IEnumerator}} collection to use as the data source.
{param}
{param:field}The name of the merge field at which to insert the values.
{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}
{introducedin:8.4}
{exception:SAException}{{SetRepeatBlock}} will throw this exception if the {{bookmark}} has been set to be  [removed|WordTemplate.BookmarksToRemove].{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|#param-bookmark] must exist in the template.  All merge fields in the repeat block will bind to the specified data source.

Not all Word features can be included in a repeat block:
{web-only:To see a full chart of limitations, go to our online documentation:}
|| Supported in Repeat Blocks || Not Supported in Repeat Blocks ||
| * Character Formatting  (everywhere)
* Paragraph Formatting (Alignment, Outlines, Indent, Spacing, Page Break before, Keep Together)
* Multiple Columns (2, 3, Column Breaks)
* Borders and Shading
* Tabs
* Bullets
* Numbering (numbering not reset, it is continued from one repeat block to another)
* Page Breaks
* Section Breaks
* Auto Text Field
* Hyperlink
* Pictures
* Table Row Repeat (entire row only)
* Fields (with some restrictions) | * Nested repeat blocks (Only one data source may be assigned to a single repeat block.)
* Overlapping bookmarks
* Comments
* Drawing Objects
* Text Boxes
* Footnote and endnote references
* Table and picture indexes
* Single cell in a table
* Smart tags (smart tags will be removed from the document)
* Repeat blocks in headers, footers, footnotes, comments,  text boxes, etc. |
{web-only}
{remarks}
{example}{code:csharp|title=C#}

          wTempl.SetRepeatBlock(coll, "ProductID", "Products");
        

{code}
{code:vb.net

|title=vb.net

}

          wTempl.SetRepeatBlock(coll, "ProductID", "Products")
        {code}

{example}