WordTemplate.SetRepeatBlock(Object(,), String(), String, Int32, Boolean)

Description

Sets the specified repeat block's data source to a multidimensional (rectangular) array of objects.

C#

vb.net

Parameters

table

An object array of values to use as a data source. WordWriter will insert these values in the repeat block's merge fields. Objects in the array must not be arrays themselves. Objects in the array can be null. Each object in the data source array must have a corresponding field name in the array of field names. By default, the first dimension corresponds to row and the second to column (that is, Object[row,column]).

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:

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.

maxRows

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.

transpose

If transpose is set to true, the array is treated as Object[column][row]. If transpose is set to false, the array is treated as Object[row][column].

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.