Articles in this section
Category / Section

How to mail merge Word document in Azure App Service Web Apps (Azure websites)

3 mins read

Mail merge is a process of merging data from a data source to Word template document. Syncfusion Essential DocIO is a .NET Word library used to generate reports like invoice, payroll, letter, and more 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 Azure App Service.

Steps to Mail merge Word document programmatically:

  1. Create a new ASP.NET Web application project. Create ASP.NET Web application in Visual Studio
  2. Install the Syncfusion.DocIO.AspNet NuGet package as a reference to your project from NuGet.org. Add DocIO NuGet package reference to the project
  3. Add a new Web Form in your project. Right-click the project, select Add > New Item, and add a Web Form from the list. Name it as MainPage.
  4. Add a new button in the MainPage.aspx as shown in the following code sample.
    <html xmlns="http://www.w3.org/1999/xhtml">
    <head runat="server">
        <title></title>
    </head>
    <body>
        <form id="form1" runat="server">
        <div>
        <asp:Button ID="Button1" runat="server" Text="Create Document" OnClick="OnButtonClicked" />
        </div>
        </form>
    </body>
    </html>
    
  1. Include the following namespaces in your MainPage.aspx.cs file.
    using Syncfusion.DocIO;
    using Syncfusion.DocIO.DLS;
    
  1. Include the following code in the click event of the button in MainPage.aspx.cs to mail merge Word document and download it.
    //Opens the Word template document
    using (WordDocument document = new WordDocument(ResolveApplicationDataPath("/") + "/Letter Formatting.docx"))
    {
        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);
     
        //Saves the Word document to disk in DOCX format
        document.Save("Result.docx", FormatType.Docx, HttpContext.Current.Response, HttpContentDisposition.Attachment);
    }
     
    //Get the path for Word template document
    protected string ResolveApplicationDataPath(string fileName)
     {
            //Data folder path is resolved from requested page physical path
            string dataPath = new System.IO.DirectoryInfo(Request.PhysicalPath + "..\\..\\Data\\").FullName;
            return string.Format("{0}\\{1}", dataPath, fileName);
    }
    

Publish in Azure App Service

  1. In Solution Explorer, right-click the project and select Publish. Publish the ASP.NET project
  2. If you have previously configured any publishing profiles, the Publish pane appears, select Create new profile.
  3. In the Pick a publish target dialog box, choose App Service. Choose App Service in publish target
  4. Select Publish. The Create App Service dialog box appears. Sign in with you Azure account if necessary, then the default app service settings populate the fields. Create Azure App Service
  5. Select Create. Visual Studio deploys the app to your Azure App Service, and the web app loads in your browser. The project properties Publish pane shows the site URL and other details. Azure published contents

A complete working example of mail merge Word document in Azure App Service 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

Take a moment to peruse the documentation, where you will find basic Word document processing options along with features like mail merge, merge and split documents, find and replace text in the Word document, protect the Word documents, and most importantly PDF and Image conversions 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 Azure Cloud Services

Mail Merge Word document in Azure functions v1

Mail Merge Word document in ASP.NET

Mail Merge Word document in ASP.NET Core

Mail Merge Word document in ASP.NET MVC

Note:

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.

 

Did you find this information helpful?
Yes
No
Help us improve this page
Please provide feedback or comments
Comments (0)
Please sign in to leave a comment
Access denied
Access denied