Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A WordWriter template is a Microsoft Word file that contains merge fields. A merge field displays a data source field (for example, a database column name). A merge field is created in Microsoft Word and bound in code to a data source. The data source may be an array, a DataSet, a DataTable, or a DataReader. When you run the code, WordWriter populates the merge fields with data source values. A template may contain multiple sets of merge fields. Each set of fields binds to a single data source. 

Merge field syntax

  • The general syntax is: DataSource.ColumnName
  • Ordinal syntax (i.e. #1.#2 for source one, column two) can also be used
  • Data source and column names must not include Unicode characters.

...

Info

Use brackets if your column name does not conform to these rules
The exception of these rules is when a column name is enclosed in brackets (for example, «Products.[Product Category]» . To include spaces or unicode characters in the data source column name, use this format:«DataSource.[Column Name]» For example: «Employees.[Street Address]» . The [Column Name] format allows you to match any SQL column name exactly. Legal characters within the brackets include every character except parentheses () or brackets [].
When creating these fields with WordApplication or editing the field codes manually, the merge field name must be enclosed in quotes. For example, it should be { MERGEFIELD "[data source].[column name]" }. Any modifiers must also go in the quotes, but the formatting options must go after the quotes.

Setting up the TemplateSetting up the Template

Adding merge fields

The final template will resemble this:

Image Added

Info
titleFollowing the Sample Code

In the downloadable FILEREFERENCE under SalesInvoice, there is a completed template file located in SalesInvoice/templates/Part1_Invoice_Template.docx.

1. Start with a blank .docx file. 

2. Add the merge fields for the header data. These values are a single row of data called "Header." The values are "FirstName," "LastName," and "Date."

3. Create a table for the order data and add the merge fields. These values are in a data table created from AdventureWorks data. In this sample, the values are "Item," "Qty," "Price," "LineTotal," "SubTotal," "Tax," and "Total."

 The template should resemble this: Image Added

Adding Styles

Adding a WordWriter Reference in Visual Studio

...