Message-ID: <568021229.8133.1711633473171.JavaMail.web05$@web05> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_8132_583318312.1711633473171" ------=_Part_8132_583318312.1711633473171 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html WordTemplate.SetRepeatBlock(Object(,), String(), String)

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

Description

=20

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

=20
C#
=20
 public void SetRepeatBlock(System.Object[,] table, System.String[] columnN=
ames, System.String bookmark)
=20
=20
vb.net
=20
Public Sub SetRepeatBlock(ByVal table As Object(,), ByVal columnNames As St=
ring(), ByVal bookmark As String)
=20
=20

Parameters

=20
tab= le
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 arra= y must not be arrays themselves. Objects in the array can be null. Each obj= ect in the data source array must have a corresponding field name in the ar= ray of field names.=20
columnNames
A string array of data source field names. These must b= e the same as the corresponding merge field names in the template.=20
= bookmark
=20

The bookmark name of the template repeat block. The bookmark passed to <= code>SetRepeatBlock must exist in the template Word file. To see a l= ist of template bookmark names:

=20
    =20
  1. Open the template in Microsoft Word.
  2. =20
  3. Open the Edit menu.
  4. =20
  5. Select Go To...
  6. =20
  7. Select Bookmark.
  8. =20
  9. Under Enter bookmark name, open the drop-down list of = bookmark names.
  10. =20
=20

Exceptions

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

Introduced in build 8.4

= =20
SAException
=20 SetRepeatBlock will throw this exception if the=20 bookmark has been set to be=20 re= moved.=20

R= emarks

=20

A repeat block is a fragment in the template document that will be repea= ted for each row in a data source. In the template document, repeat blocks = are defined by Word bookmarks that contain merge fields.

=20

You can call SetRepeatBlock several times for a single instance of WordTemplate. The repe= at block specified by the parameter bookmark must exist in the= template.

=20

If you pass an empty data source to SetRepeatBlock WordWrit= er will not include the specified repeat block in the generated Word file.<= /p>=20

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

$body=20
=20 =20 =20 =20 =20 =20 =20 =20 =20

Supported in Repeat Blocks

Not Supported in Repeat Blocks

    =20
  • Character Formatting (everywhere)
  • =20
  • Paragraph Formatting (Alignment, Outlines, Indent, Spacing, Page Break = before, Keep Together)
  • =20
  • Multiple Columns (2, 3, Column Breaks)
  • =20
  • Borders and Shading
  • =20
  • Tabs
  • =20
  • Bullets
  • =20
  • Numbering (numbering not reset, it is continued from one repeat block t= o another)
  • =20
  • Page Breaks
  • =20
  • Section Breaks
  • =20
  • Auto Text Field
  • =20
  • Hyperlink
  • =20
  • Pictures
  • =20
  • Table Row Repeat (entire row only)
  • =20
  • Fields (with some restrictions)
  • =20
    =20
  • Nested repeat blocks (Only one data source may be assigned to a single = repeat block.)
  • =20
  • Overlapping bookmarks
  • =20
  • Comments
  • =20
  • Drawing Objects
  • =20
  • Text Boxes
  • =20
  • Footnote and endnote references
  • =20
  • Table and picture indexes
  • =20
  • Single cell in a table
  • =20
  • Smart tags (smart tags will be removed from the document)
  • =20
  • Repeat blocks in headers, footers, footnotes, comments, text boxes, etc= .
  • =20
$body=20

= Examples

=20
C#
=20

          //--- A 2-D rectangular array of values
          string[,] ValuesArr =3D {{"Boston", "MA"},
               {"Miami", "FL"},
               {"Merchantville", "NJ"}};

          //--- Names array, elements correspond to merge field names
          string[] NamesArr =3D {"City", "State"};
          WordTemplate wt =3D new WordTemplate();
          wt.Open("template.doc");

          //--- Set the repeat block defined by the bookmark "Block&qu=
ot;
          //--- The data source is the 2-D rectangular ValuesArr array
          wt.SetRepeatBlock(ValuesArr, NamesArr, "Block");
          wt.Process();
          wt.Save("out.doc");
        
=20
=20
vb.net
=20

          '--- A 2-D rectangular array of values
          Dim ValuesArr As String(,)  =3D {{"Boston", "MA&qu=
ot;}, _
               {"Miami", "FL"}, _
               {"Merchantville", "NJ"}}

          '--- Names array, elements correspond to merge field names
          Dim NamesArr As String() =3D {"City", "State"=
}
          Dim wt As New WordTemplate()
          wt.Open("template.doc")

          '--- Set the repeat block defined by the bookmark "Block&quo=
t;
          '--- The data source is the 2-D rectangular ValuesArr array
          wt.SetRepeatBlock(ValuesArr, NamesArr, "Block")
          wt.Process()
          wt.Save("out.doc")
        
=20
------=_Part_8132_583318312.1711633473171--