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

...

Remarks

You can call SetMailMerge once for each instance of WordTemplate. If you are using the Excel Word 2003 binary template file type (.xlsdoc/.xltdot), you can call SetMailMerge or SetRepeatBlock, but not both.

Additionally, only the page content is repeated for each row, not the entire page itself. If you wish to have the page itself repeat for each row, you will need to remember to place a page break at the bottom of the page.If you wish to have the page itself repeat for each row, you will need to remember to place a page break at the bottom of the page.  Alternatively, you can create a hidden page break at the top of the page as follows:

  • Put the cursor at the top of the document
  • Go to Page Layout and open the paragraph formatting dialog
  • On the Line and Page Breaks tab,  select "Page Break Before"

Merge Fields for using the SetMailMerge method must not specify a data source – the data source is implied, and using a data source name will cause WordTemplate to throw an error. Valid merge field formats for use with SetMailMerge include field names («fieldname») and field ordinals («#1»).

Introducedin
8.2
8.2

SetMailMerge will now work with headers and footers. A section break is required instead of a page break if each header or footer will be different.

Example
Code Block
csharp
csharp
titleC#

          ...
          //--- A 2-D jagged array of values
          object[][] data = new object[][]{
               new string[]{"Knoxville","Tennessee"},
               new string[]{"Boston","Massachusetts"},
               new string[]{"Washington","DC"},
               new string[]{"Seattle","Washington"},
               new string[]{"Chicago", "Illinois"},
               new string[]{"New York","New York"},
               new string[]{"Atlanta", "Georgia"},
               new string[]{"Los Angeles", "California"},
               new string[]{"Houston", "Texas"}
               };

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

          //--- Set the mail merge
          //--- The data source is the 2-D jagged data array
          wt.SetMailMerge(data, names);
          wt.Process();
          wt.Save(Page.Response, "output.doc", false);
        
Code Block
vb.net
vb.net
titlevb.net

          ...
          '--- A 2-D jagged array of values
          Dim data()() As Object = { _
               New Object() {"Knoxville", "Tennessee"}, _
               New Object() {"Boston", "Massachusetts"}, _
               New Object() {"Washington", "DC"}, _
               New Object() {"Seattle", "Washington"}, _
               New Object() {"Chicago", "Illinois"}, _
               New Object() {"New York", "New York"}, _
               New Object() {"Atlanta", "Georgia"}, _
               New Object() {"Los Angeles", "California"}, _
               New Object() {"Houston", "Texas"} _
               }

          '--- names array, elements correspond to merge field names
          Dim names() As String = {"City", "State"}
          Dim wt As New WordTemplate()
          wt.Open(Server.MapPath("template/MergeFieldTest.doc"))

          '--- Set the mail merge
          '--- The data source is the 2-D jagged data array
          wt.SetMailMerge(data, names)
          wt.Process()
          wt.Save(Page.Response, "output.doc", False)
          ...