Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Table of Contents

Getting Started

About templates and merge fields

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.
  • Data source and column names must begin with a letter (A-Z, a-z).
  • Data source and column names may include the following characters only:
    ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890_
    Icon

    If you assigned a different data source separator, you can also use a "." in your data source and column names.

  • Spaces are not allowed anywhere in a merge field.
Icon

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]»

Setting up the Template

Adding merge fields

The final template will resemble this:

Following the Sample Code

Icon

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:

Adding Styles

Adding a WordWriter Reference in Visual Studio

Writing the Code

Final Code

Downloads

Next Steps

  • No labels