We use cookies to give you the best experience on our website. If you continue to browse, then you agree to our privacy policy and cookie policy. Image for the cookie policy date
Unfortunately, activation email could not send to your email. Please try again.
Syncfusion Feedback

How to mail merge Word document in UWP?

Platform: UWP |
Control: DocIO

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:

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


   <Grid Background="{ThemeResource ApplicationPageBackgroundThemeBrush}">
         <Button x:Name="button" Content="Create Document" Click="OnButtonClicked" HorizontalAlignment="Center" VerticalAlignment="Center"/>
  1. 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;
  1. 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();
           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);
       // 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.

See Also:

Mail Merge Word document in Windows Forms

Mail Merge Word document in WPF

Mail Merge Word document in C#

Mail Merge Word document in ASP.NET

Mail Merge Word document in ASP.NET MVC

Mail Merge Word document in ASP.NET Core

Mail Merge Word document in Xamarin

Mail Merge Word document in Xamarin.Android

Mail Merge Word document in Xamarin.iOS


Starting with v16.2.0.x, if you reference Syncfusion assemblies from trial setup or from the NuGet feed, include a license key in your projects. Refer to link to learn about generating and registering Syncfusion license key in your application to use the components without trail message.



I hope you enjoyed learning about how to mail merge Word document in UWP.

You can refer to our UWP Word library feature tour page to know about its other groundbreaking feature representations. You can also explore our UWP Word library documentation to understand how to present and manipulate data.

For current customers, you can check out our UWP components from the License and Downloads page. If you are new to Syncfusion, you can try our 30-day free trial to check out our UWP Word and other UWP components.

If you have any queries or require clarifications, please let us know in comments below. You can also contact us through our support forumsDirect-Trac, or feedback portal. We are always happy to assist you!


2X faster development

The ultimate UWP UI toolkit to boost your development speed.
You must log in to leave a comment

Please sign in to access our KB

This page will automatically be redirected to the sign-in page in 10 seconds.

Up arrow icon

Warning Icon You are using an outdated version of Internet Explorer that may not display all features of this and other websites. Upgrade to Internet Explorer 8 or newer for a better experience.Close Icon

Live Chat Icon For mobile