How to mail merge Word document in UWP?

3 mins read

Mail merge is a process of merging data from a data source to a Word template document. Syncfusion Essential DocIO is a UWP Word library used to generate reports like invoice, payroll, letter, etc., by performing mail merge faster in a batch process without Microsoft Word or interop dependencies. Using this library, you can mail merge Word document in UWP.

Steps to Mail merge Word document programmatically in UWP:

Create a new C# Blank App (Universal Windows) project.
Install the Syncfusion.DocIO.UWP NuGet package as a reference to your UWP application from NuGet.org.
Add a new button in the MainPage.xaml as shown below.

XAML

<Page
   x:Class="CreateWordSample.MainPage"
   xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
   xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
   xmlns:local="using:CreateWordSample"
   xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
   xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
   mc:Ignorable="d">
   <Grid Background="{ThemeResource ApplicationPageBackgroundThemeBrush}">
         <Button x:Name="button" Content="Create Document" Click="OnButtonClicked" HorizontalAlignment="Center" VerticalAlignment="Center"/>
   </Grid>
</Page>

Include the following namespaces in the MainPage.xaml.cs file.

using Syncfusion.DocIO;
using Syncfusion.DocIO.DLS;
using Windows.Storage.Pickers;
using Windows.Storage;
using Windows.Storage.Streams;
using System.Reflection;

Include the below code in the click event of the button in MainPage.xaml.cs, to mail merge Word document and save the Word file as a physical file and open the file for viewing.

//Opens the Word template document
using (WordDocument document = new WordDocument())
{
    string[] fieldNames = { "ContactName", "CompanyName", "Address", "City", "Country", "Phone"};
    string[] fieldValues = { "Nancy Davolio", "Syncfusion", "507 - 20th Ave. E.Apt. 2A", "Seattle, WA", "USA", "(206) 555-9857-x5467" };
    //Performs the mail merge
    document.MailMerge.Execute(fieldNames, fieldValues);
   MemoryStream stream = new MemoryStream();
   //Saves the Word file to MemoryStream
   await document.SaveAsync(stream, FormatType.Docx);
   //Saves the stream as Word file in local machine
   Save(stream, "Result.docx");
}
   // Saves the Word document
   async void Save(MemoryStream streams, string filename)
   {
       streams.Position = 0;
       StorageFile stFile;
       if (!(Windows.Foundation.Metadata.ApiInformation.IsTypePresent("Windows.Phone.UI.Input.HardwareButtons")))
       {
           FileSavePicker savePicker = new FileSavePicker();
           savePicker.DefaultFileExtension = ".docx";
           savePicker.SuggestedFileName = filename;
           savePicker.FileTypeChoices.Add("Word Documents", new List<string>() { ".docx" });
           stFile = await savePicker.PickSaveFileAsync();
       }
       else
       {
           StorageFolder local = Windows.Storage.ApplicationData.Current.LocalFolder;
           stFile = await local.CreateFileAsync(filename, CreationCollisionOption.ReplaceExisting);
       }
       if (stFile != null)
       {
           using (IRandomAccessStream zipStream = await stFile.OpenAsync(FileAccessMode.ReadWrite))
           {
               // Write compressed data from memory to file
               using (Stream outstream = zipStream.AsStreamForWrite())
               {
      byte[] buffer = streams.ToArray();
      outstream.Write(buffer, 0, buffer.Length);
      outstream.Flush();
               }
           }
       }
       // Launch the saved Word file
       await Windows.System.Launcher.LaunchFileAsync(stFile);
   }

A complete working example of mail merge Word document in UWP can be downloaded from mail merge Word document.zip

By executing the program, you will get the Word document as follows. Mail merge output Word document in UWP

Take a moment to peruse the documentation, where you can find basic Word document processing options along with features like mail merge, merge and split documents, find and replace text in the Word document and protect the Word documents with code examples.

Explore more about the rich set of Syncfusion Word Framework features.

An online example to perform mail merge in Word document.

How to mail merge Word document in UWP?

Steps to Mail merge Word document programmatically in UWP:

Access denied