Skip to end of metadata
Go to start of metadata

Description

Sets the specified repeat block's data source to a jagged array (array-of-arrays) of objects.

C#
vb.net

Parameters

jaggedArray
An jagged array of objects to use as a data source. the first dimension corresponds to row and the second to column (that is, Object[row][column]). WordWriter will insert these values in the repeat block's merge fields.
columnNames
A string array of data source field names. These must be the same as the corresponding merge field names in the template.
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

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

Introduced in build 8.4

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.

If you pass an empty data source to SetRepeatBlock WordWriter will not include the specified repeat block in the generated Word file.
Not all Word features can be included in a repeat block:

$body

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.
$body

Examples

C#
vb.net
  • No labels