DocWright.MailMerge 1.1.4

dotnet add package DocWright.MailMerge --version 1.1.4
                    
NuGet\Install-Package DocWright.MailMerge -Version 1.1.4
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="DocWright.MailMerge" Version="1.1.4" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="DocWright.MailMerge" Version="1.1.4" />
                    
Directory.Packages.props
<PackageReference Include="DocWright.MailMerge" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add DocWright.MailMerge --version 1.1.4
                    
#r "nuget: DocWright.MailMerge, 1.1.4"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package DocWright.MailMerge@1.1.4
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=DocWright.MailMerge&version=1.1.4
                    
Install as a Cake Addin
#tool nuget:?package=DocWright.MailMerge&version=1.1.4
                    
Install as a Cake Tool

DocWright.MailMerge

Fill a Word template from your own data: merge fields, repeating regions for tables and line items, nested relations, and one copy of the template per record in a single output document, separated by a page break, a section break or nothing.

No System.Data dependency — bind from objects, dictionaries or your own reader.

Add-on for DocWright.

Install

dotnet add package DocWright.MailMerge

You will normally also want the main package, which loads and saves documents:

dotnet add package DocWright

Usage

using DocWright;
using DocWright.Dom;
using DocWright.MailMerge;
using System.Globalization;

var converter = new DocWrightConverter();

var map = new MergeFieldMap<Order>()
    .Add("CustomerName", o => o.Customer)
    .Add("Total", o => o.Total)
    .AddRelation("Items", o => o.Lines, new MergeFieldMap<Line>()
        .Add("Description", l => l.Description)
        .Add("Amount", l => l.Amount));

using WordDocument document = converter.Load(File.OpenRead("invoice-template.docx"));

// Reject a bad template before you have any data.
document.ValidateMergeRegions();

MergeResult result = document.Execute(
    MergeDataSource.FromObjects(orders, map),
    new MailMergeOptions
    {
        Culture = CultureInfo.GetCultureInfo("en-US"),   // explicit, never ambient
        RecordSeparator = MergeRecordSeparator.PageBreak,
    });

if (result.UnmergedFieldNames.Count > 0)
{
    Console.WriteLine("Template asked for: " + string.Join(", ", result.UnmergedFieldNames));
}

using FileStream output = File.Create("invoices.docx");
converter.Save(document, output);

Binding without a typed map

document.Execute(MergeDataSource.FromDictionaries(rows));   // many records
document.Execute(MergeDataSource.FromDictionary(row));      // one record

What you get

  • MERGEFIELD discovery and substitution, including fields split across runs
  • Repeating regions (TableStart: / TableEnd:) with nesting and NEXT
  • Nested relations through AddRelation
  • MergeImage / MergeImageRequest to merge pictures, not just text
  • ValidateMergeRegions() to fail a malformed template early
  • UnmergedFields policy for fields your data does not supply

Determinism

Culture is explicit and never taken from the ambient thread culture, so a merge produces the same output on every machine.

Requirements

.NET Framework 4.8, .NET Standard 2.0, .NET 8.0 or .NET 10.0.

Documentation

📖 DocWright documentation · Tutorial: generate invoices with mail merge · Mail merge data sources and options · API reference: DocWright.MailMerge

Contact

Questions, support or licensing: salwan@albahadly.com · www.albahadly.com

License

MIT.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 is compatible.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.1.4 74 9/28/2026
1.1.3 74 9/28/2026
1.1.2 113 9/3/2026
1.1.1 103 8/22/2026
1.1.0 96 8/22/2026

Guides, tutorials and API reference: https://docs.albahadly.com/docwright/