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
Description

Excerpt

Sets the specified repeat block's data source to an

Msdn
System.Collections.ICollection
System.Collections.ICollection
1ICollection
.

Signature
C#
C#
 public void SetRepeatBlock(System.Collections.ICollection dataSource, System.String bookmark)
Signature
vb.net
vb.net
Public Sub SetRepeatBlock(ByVal dataSource As System.Collections.ICollection, ByVal bookmark As String)
Parameters
Param
dataSource
dataSource

An ICollection to use as the data source.

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

Introducedin
8.4
8.4
Exception
SAException
SAException

SetRepeatBlock will throw this exception if the bookmark has been set to be removed.

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

Example
Code Block
csharp
csharp
titleC#

          wTempl.SetRepeatBlock(coll, "Products");
        
Code Block
vb.net
vb.net
titlevb.net

          wTempl.SetRepeatBlock(coll, "Products")