Mail Merge Example for WinForms

Nevron NOV RichTextEditor for WinForms ships with hundreds of examples with full source code, as part of the Nevron Open Vision Suite. All WinForms RichTextEditor examples are also available as a stand-alone Visual Studio solution in C# and VB.NET, which you can download from the links below.

Mail Merge Example for WinForms Description

This example demonstrates how to use the mail merge functionality of the Nevron Rich Text control.

Click the Preview Mail Merge button from the Mailings ribbon tab to see the values for the currently selected mail merge record. When ready click the Merge and Save button to save all merged documents to a file.

The Merge and Save button saves each of the individual documents result of the mail merge operation to a folder.


Mail Merge Example

C# Mail Merge Example Code for Nevron RichTextEditor for WinForms
Language: C#

using Nevron.Nov;
using Nevron.Nov.Dom;
using Nevron.Nov.Graphics;
using Nevron.Nov.IO;
using Nevron.Nov.Layout;
using Nevron.Nov.Text;
using Nevron.Nov.Text.Data;
using Nevron.Nov.UI;
using Nevron.Nov.Windows.Forms;
using System;
using System.Globalization;
using System.IO;
using System.Windows.Forms;

namespace NovWinFormsProject
{
	public partial class Form1 : Form
	{
		#region Constructors

		public Form1()
		{
			InitializeComponent();

			// Set form title
			Text = "NOV WinForms - NMailMergeExample";

			// Create the NOV example and its controls
			NWidget exampleContent = CreateExampleContent();
			NWidget exampleControls = CreateExampleControls();
			if (exampleControls != null)
			{
				exampleControls.PreferredWidth = 300;
			}

			// Place the example and its controls in a pair box
			NPairBox pairBox = new NPairBox(exampleContent, exampleControls);
			pairBox.FillMode = ENStackFillMode.First;
			pairBox.FitMode = ENStackFitMode.First;
			pairBox.Margins = new NMargins(NDesign.HorizontalSpacing, NDesign.VerticalSpacing);

			// Host the example in the form
			NNovWidgetHost host = new NNovWidgetHost(pairBox);
			host.Dock = DockStyle.Fill;
			Controls.Add(host);
		}

		#endregion

		#region Example

		public NWidget CreateExampleContent()
		{
			// Create the rich text
			NRichTextViewWithRibbon richTextWithRibbon = new NRichTextViewWithRibbon();
			m_RichText = richTextWithRibbon.View;
			m_RichText.AcceptsTab = true;
			m_RichText.Content.Sections.Clear();

			// Populate the rich text
			PopulateRichText();

			return richTextWithRibbon;
		}
		public NWidget CreateExampleControls()
		{
			NStackPanel stack = new NStackPanel();

			if (NApplication.IntegrationPlatform != ENIntegrationPlatform.Blazor)
			{
				NButton mergeAndSaveToFolderButton = new NButton("Merge & Save to Folder");
				mergeAndSaveToFolderButton.Click += OnMergeAndSaveToFolderButtonClick;
				stack.Add(mergeAndSaveToFolderButton);
			}

			return stack;
		}
		public string GetExampleDescription()
		{
			string previewMailMergeUri = NUriHelpers.CreateDataUriString(Nevron.Nov.Graphics.NImage.FromBytes(Nevron.Nov.NConvert.FromBase64String("iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAABrElEQVR4Ac2OA6ydQRBGt3Zj1LZt2whq2+bVM++zbdsIarsNaptBrdN/alsn+bLfcEf9EeydzFa29o7Y2DkgEu/g7GKtvgcbe8cr6enpfIzktNrVrw/bOVolpyQjLArdRGd9Cl0MKSwN24yQotVs7Z2s1MeMHTcBeS0srXny8B7LYnZTeOwO3Xr0oVXHXizLPM3K2D1Sw9LaBukdP2EiShg5crSYNuL1RhPCyIADtG3Tnvh95/HcdZ4qjdswOvAAgtFkgXpFm5ezfXr3fZNQ63QGePaYqcmXqVm3IVXqNqZqo2ZUbtCEaVpOajq96W3/m9k2LVu05M2Ca1cv47rrHqpkBXzOQdJjKFamIpK7duUyOqM10tuiZdu3l6s3ZvbceUFBwcHcun0H74OwapumreCl+Ztaztc/CGsnL96f+ZjKK1auvuXvH8Dpk8e4efUiIvE+vgGs1tny/PFt9np1RX2F5tOmzwpevnwVy5ateCXNL12pY2PEashuCA92stu7z1eXVJYTP1a6ZR+ehleHvFZs9RiA+gnaJFoMJsE0hCP+XTeqn+TNRXXUf8ELg3Iu6K3kg3kAAAAASUVORK5CYII=")));
			return $@"

This example demonstrates how to use the mail merge functionality of the Nevron Rich Text control.

Click the Preview Mail Merge button () from the Mailings ribbon tab to see the values for the currently selected mail merge record. When ready click the Merge & Save button to save all merged documents to a file.

The Merge & Save button saves each of the individual documents result of the mail merge operation to a folder.

"; } /// /// Gets the relevant documentation links for the example /// /// public (string Name, string Url)[] GetDocumentationUrls() { return new[] { ("Rich Text - Mail Merge Overview", "https://www.nevron.com/docs/openvision/rich-text-mail-merge-overview.html"), ("Rich Text - Mail Merge Fields", "https://www.nevron.com/docs/openvision/rich-text-mail-merge-fields.html"), ("Rich Text - Mail Merge Data Sources", "https://www.nevron.com/docs/openvision/rich-text-mail-merge-data-sources.html"), ("Rich Text Field Inlines", "https://www.nevron.com/docs/openvision/rich-text-field-inlines.html"), ("Data Sources", "https://www.nevron.com/docs/openvision/data-sources.html"), }; } private void PopulateRichText() { // Create some text NDocumentBlock documentBlock = m_RichText.Content; documentBlock.Layout = ENTextLayout.Print; NSection section = new NSection(); documentBlock.Sections.Add(section); NParagraph paragraph = new NParagraph(); paragraph.Inlines.Add(CreateMailMergeField(new NGreetingLineFieldValue())); section.Blocks.Add(paragraph); paragraph = new NParagraph(); paragraph.Inlines.Add(new NTextInline("We would like to offer you a unique software component that will help you leverage multiple platforms with single code base. We believe that as a ")); paragraph.Inlines.Add(CreateMailMergeField(new NMailMergeSourceFieldValue("Title"))); paragraph.Inlines.Add(new NTextInline(" in your company you will be very interested in this solution. If that's the case do not hesitate to contact us in order to arrange a meeting in ")); paragraph.Inlines.Add(CreateMailMergeField(new NMailMergePredefinedFieldValue(ENMailMergeDataField.City))); paragraph.Inlines.Add(new NTextInline(".")); section.Blocks.Add(paragraph); paragraph = new NParagraph(); paragraph.Inlines.Add(new NTextInline("Best Regards,")); paragraph.Inlines.Add(new NLineBreakInline()); paragraph.Inlines.Add(new NTextInline("Nevron Software")); paragraph.Inlines.Add(new NLineBreakInline()); paragraph.Inlines.Add(new NFieldInline("www.nevron.com", new NUrlHyperlink("https://www.nevron.com"))); section.Blocks.Add(paragraph); // Load a mail merge data source from resource NMailMergeDataSource dataSource; using (Stream stream = new MemoryStream(Nevron.Nov.NConvert.FromBase64String("RW1wbG95ZWVJRDtMYXN0TmFtZTtGaXJzdE5hbWU7VGl0bGU7VGl0bGVPZkNvdXJ0ZXN5O0JpcnRoRGF0ZTtIaXJlRGF0ZTtBZGRyZXNzO0NpdHk7UmVnaW9uO1Bvc3RhbENvZGU7Q291bnRyeTtIb21lUGhvbmU7RXh0ZW5zaW9uO1Bob3RvO05vdGVzO1JlcG9ydHNUbw0KMTtEYXZvbGlvO05hbmN5O1NhbGVzIFJlcHJlc2VudGF0aXZlO01zLjs4LjEyLjE5Njg7MS41LjE5OTI7IjUwNyAtIDIwdGggQXZlLiBFLg0KQXB0LiAyQSI7U2VhdHRsZTtXQTs5ODEyMjtVU0E7KDIwNikgNTU1LTk4NTc7NTQ2NztFbXBJRDEuYm1wOyJFZHVjYXRpb24gaW5jbHVkZXMgYSBCQSBpbiBwc3ljaG9sb2d5IGZyb20gQ29sb3JhZG8gU3RhdGUgVW5pdmVyc2l0eS4gIFNoZSBhbHNvIGNvbXBsZXRlZCAiIlRoZSBBcnQgb2YgdGhlIENvbGQgQ2FsbC4iIiAgTmFuY3kgaXMgYSBtZW1iZXIgb2YgVG9hc3RtYXN0ZXJzIEludGVybmF0aW9uYWwuIjsyDQoyO0Z1bGxlcjtBbmRyZXc7VmljZSBQcmVzaWRlbnQsIFNhbGVzO0RyLjsxOS4yLjE5NTI7MTQuOC4xOTkyOzkwOCBXLiBDYXBpdGFsIFdheTtUYWNvbWE7V0E7OTg0MDE7VVNBOygyMDYpIDU1NS05NDgyOzM0NTc7RW1wSUQyLmJtcDtBbmRyZXcgcmVjZWl2ZWQgaGlzIEJUUyBjb21tZXJjaWFsIGFuZCBhIFBoLkQuIGluIGludGVybmF0aW9uYWwgbWFya2V0aW5nIGZyb20gdGhlIFVuaXZlcnNpdHkgb2YgRGFsbGFzLiAgSGUgaXMgZmx1ZW50IGluIEZyZW5jaCBhbmQgSXRhbGlhbiBhbmQgcmVhZHMgR2VybWFuLiAgSGUgam9pbmVkIHRoZSBjb21wYW55IGFzIGEgc2FsZXMgcmVwcmVzZW50YXRpdmUsIHdhcyBwcm9tb3RlZCB0byBzYWxlcyBtYW5hZ2VyIGFuZCB3YXMgdGhlbiBuYW1lZCB2aWNlIHByZXNpZGVudCBvZiBzYWxlcy4gIEFuZHJldyBpcyBhIG1lbWJlciBvZiB0aGUgU2FsZXMgTWFuYWdlbWVudCBSb3VuZHRhYmxlLCB0aGUgU2VhdHRsZSBDaGFtYmVyIG9mIENvbW1lcmNlLCBhbmQgdGhlIFBhY2lmaWMgUmltIEltcG9ydGVycyBBc3NvY2lhdGlvbi47DQozO0xldmVybGluZztKYW5ldDtTYWxlcyBSZXByZXNlbnRhdGl2ZTtNcy47MzAuOC4xOTYzOzEuNC4xOTkyOzcyMiBNb3NzIEJheSBCbHZkLjtLaXJrbGFuZDtXQTs5ODAzMztVU0E7KDIwNikgNTU1LTM0MTI7MzM1NTtFbXBJRDMuYm1wO0phbmV0IGhhcyBhIEJTIGRlZ3JlZSBpbiBjaGVtaXN0cnkgZnJvbSBCb3N0b24gQ29sbGVnZSkuICBTaGUgaGFzIGFsc28gY29tcGxldGVkIGEgY2VydGlmaWNhdGUgcHJvZ3JhbSBpbiBmb29kIHJldGFpbGluZyBtYW5hZ2VtZW50LiAgSmFuZXQgd2FzIGhpcmVkIGFzIGEgc2FsZXMgYXNzb2NpYXRlIGFuZCB3YXMgcHJvbW90ZWQgdG8gc2FsZXMgcmVwcmVzZW50YXRpdmUuOzINCjQ7UGVhY29jaztNYXJnYXJldDtTYWxlcyBSZXByZXNlbnRhdGl2ZTtNcnMuOzE5LjkuMTk1ODszLjUuMTk5Mzs0MTEwIE9sZCBSZWRtb25kIFJkLjtSZWRtb25kO1dBOzk4MDUyO1VTQTsoMjA2KSA1NTUtODEyMjs1MTc2O0VtcElENC5ibXA7TWFyZ2FyZXQgaG9sZHMgYSBCQSBpbiBFbmdsaXNoIGxpdGVyYXR1cmUgZnJvbSBDb25jb3JkaWEgQ29sbGVnZSBhbmQgYW4gTUEgZnJvbSB0aGUgQW1lcmljYW4gSW5zdGl0dXRlIG9mIEN1bGluYXJ5IEFydHMuIFNoZSB3YXMgdGVtcG9yYXJpbHkgYXNzaWduZWQgdG8gdGhlIExvbmRvbiBvZmZpY2UgYmVmb3JlIHJldHVybmluZyB0byBoZXIgcGVybWFuZW50IHBvc3QgaW4gU2VhdHRsZS47Mg0KNTtCdWNoYW5hbjtTdGV2ZW47U2FsZXMgTWFuYWdlcjtNci47NC4zLjE5NTU7MTcuMTAuMTk5MzsxNCBHYXJyZXR0IEhpbGw7TG9uZG9uOztTVzEgOEpSO1VLOyg3MSkgNTU1LTQ4NDg7MzQ1MztFbXBJRDUuYm1wOyJTdGV2ZW4gQnVjaGFuYW4gZ3JhZHVhdGVkIGZyb20gU3QuIEFuZHJld3MgVW5pdmVyc2l0eSwgU2NvdGxhbmQsIHdpdGggYSBCU0MgZGVncmVlLiAgVXBvbiBqb2luaW5nIHRoZSBjb21wYW55IGFzIGEgc2FsZXMgcmVwcmVzZW50YXRpdmUsIGhlIHNwZW50IDYgbW9udGhzIGluIGFuIG9yaWVudGF0aW9uIHByb2dyYW0gYXQgdGhlIFNlYXR0bGUgb2ZmaWNlIGFuZCB0aGVuIHJldHVybmVkIHRvIGhpcyBwZXJtYW5lbnQgcG9zdCBpbiBMb25kb24sIHdoZXJlIGhlIHdhcyBwcm9tb3RlZCB0byBzYWxlcyBtYW5hZ2VyLiAgTXIuIEJ1Y2hhbmFuIGhhcyBjb21wbGV0ZWQgdGhlIGNvdXJzZXMgIiJTdWNjZXNzZnVsIFRlbGVtYXJrZXRpbmciIiBhbmQgIiJJbnRlcm5hdGlvbmFsIFNhbGVzIE1hbmFnZW1lbnQuIiIgIEhlIGlzIGZsdWVudCBpbiBGcmVuY2guIjsyDQo2O1N1eWFtYTtNaWNoYWVsO1NhbGVzIFJlcHJlc2VudGF0aXZlO01yLjsyLjcuMTk2MzsxNy4xMC4xOTkzOyJDb3ZlbnRyeSBIb3VzZQ0KTWluZXIgUmQuIjtMb25kb247O0VDMiA3SlI7VUs7KDcxKSA1NTUtNzc3Mzs0Mjg7RW1wSUQ2LmJtcDsiTWljaGFlbCBpcyBhIGdyYWR1YXRlIG9mIFN1c3NleCBVbml2ZXJzaXR5IChNQSwgZWNvbm9taWNzKSBhbmQgdGhlIFVuaXZlcnNpdHkgb2YgQ2FsaWZvcm5pYSBhdCBMb3MgQW5nZWxlcyAoTUJBLCBtYXJrZXRpbmcpLiAgSGUgaGFzIGFsc28gdGFrZW4gdGhlIGNvdXJzZXMgIiJNdWx0aS1DdWx0dXJhbCBTZWxsaW5nIiIgYW5kICIiVGltZSBNYW5hZ2VtZW50IGZvciB0aGUgU2FsZXMgUHJvZmVzc2lvbmFsLiIiICBIZSBpcyBmbHVlbnQgaW4gSmFwYW5lc2UgYW5kIGNhbiByZWFkIGFuZCB3cml0ZSBGcmVuY2gsIFBvcnR1Z3Vlc2UsIGFuZCBTcGFuaXNoLiI7NQ0KNztLaW5nO1JvYmVydDtTYWxlcyBSZXByZXNlbnRhdGl2ZTtNci47MjkuNS4xOTYwOzIuMS4xOTk0OyJFZGdlaGFtIEhvbGxvdw0KV2luY2hlc3RlciBXYXkiO0xvbmRvbjs7UkcxIDlTUDtVSzsoNzEpIDU1NS01NTk4OzQ2NTtFbXBJRDcuYm1wOyJSb2JlcnQgS2luZyBzZXJ2ZWQgaW4gdGhlIFBlYWNlIENvcnBzIGFuZCB0cmF2ZWxlZCBleHRlbnNpdmVseSBiZWZvcmUgY29tcGxldGluZyBoaXMgZGVncmVlIGluIEVuZ2xpc2ggYXQgdGhlIFVuaXZlcnNpdHkgb2YgTWljaGlnYW4gYW5kIHRoZW4gam9pbmluZyB0aGUgY29tcGFueS4gIEFmdGVyIGNvbXBsZXRpbmcgYSBjb3Vyc2UgZW50aXRsZWQgIiJTZWxsaW5nIGluIEV1cm9wZSwiIiBoZSB3YXMgdHJhbnNmZXJyZWQgdG8gdGhlIExvbmRvbiBvZmZpY2UuIjs1DQo4O0NhbGxhaGFuO0xhdXJhO0luc2lkZSBTYWxlcyBDb29yZGluYXRvcjtNcy47OS4xLjE5NTg7NS4zLjE5OTQ7NDcyNiAtIDExdGggQXZlLiBOLkUuO1NlYXR0bGU7V0E7OTgxMDU7VVNBOygyMDYpIDU1NS0xMTg5OzIzNDQ7RW1wSUQ4LmJtcDtMYXVyYSByZWNlaXZlZCBhIEJBIGluIHBzeWNob2xvZ3kgZnJvbSB0aGUgVW5pdmVyc2l0eSBvZiBXYXNoaW5ndG9uLiAgU2hlIGhhcyBhbHNvIGNvbXBsZXRlZCBhIGNvdXJzZSBpbiBidXNpbmVzcyBGcmVuY2guICBTaGUgcmVhZHMgYW5kIHdyaXRlcyBGcmVuY2guOzINCjk7RG9kc3dvcnRoO0FubmU7U2FsZXMgUmVwcmVzZW50YXRpdmU7TXMuOzIuNy4xOTY5OzE1LjExLjE5OTQ7NyBIb3VuZHN0b290aCBSZC47TG9uZG9uOztXRzIgN0xUO1VLOyg3MSkgNTU1LTQ0NDQ7NDUyO0VtcElEOS5ibXA7QW5uZSBoYXMgYSBCQSBkZWdyZWUgaW4gRW5nbGlzaCBmcm9tIFN0LiBMYXdyZW5jZSBDb2xsZWdlLiAgU2hlIGlzIGZsdWVudCBpbiBGcmVuY2ggYW5kIEdlcm1hbi47NQ0K"))) { dataSource = NDataSourceFormat.Csv.LoadFromStream(stream, new NDataSourceLoadSettings(null, null, true)); } // Create the field mappings NMailMergeFieldMap fieldMap = new NMailMergeFieldMap(); fieldMap.Set(ENMailMergeDataField.CourtesyTitle, "TitleOfCourtesy"); fieldMap.Set(ENMailMergeDataField.FirstName, "FirstName"); fieldMap.Set(ENMailMergeDataField.LastName, "LastName"); fieldMap.Set(ENMailMergeDataField.City, "City"); dataSource.FieldMap = fieldMap; documentBlock.MailMerge.DataSource = dataSource; } #endregion #region Implementation private void MergeAndSaveToFolder(string targetPath) { NFolder folder = NFileSystem.Current.GetFolder(targetPath); if (folder == null) { NMessageBox.Show("The entered target path does not exist", "Error", ENMessageBoxButtons.OK, ENMessageBoxIcon.Error); return; } // Clone the rich text view NRichTextView clonedRichTextView = (NRichTextView)m_RichText.DeepClone(); // Switch the mail merge of the cloned rich text view to preview mode NMailMerge mailMerge = clonedRichTextView.Content.MailMerge; mailMerge.PreviewMailMerge = true; // Loop through all mail merge records to save individual documents to file for (int i = 0; i < mailMerge.DataRecordCount; i++) { // Move to the next data source record mailMerge.CurrentDataRecordIndex = i; // Save the merged document to file string fileName = "Document" + i.ToString(CultureInfo.InvariantCulture) + ".docx"; clonedRichTextView.SaveToFileAsync(NPath.Current.Combine(targetPath, fileName)); } NMessageBox.Show("Merged documents saved to \"" + targetPath + "\".", "Mail Merge Complete", ENMessageBoxButtons.OK, ENMessageBoxIcon.Information); } #endregion #region Event Handlers private void OnMergeAndSaveToFolderButtonClick(NEventArgs arg) { NTextBox textBox = new NTextBox(); NButtonStrip buttonStrip = new NButtonStrip(); buttonStrip.AddOKCancelButtons(); NPairBox pairBox = new NPairBox(textBox, buttonStrip, ENPairBoxRelation.Box1AboveBox2); NTopLevelWindow dialog = NApplication.CreateTopLevelWindow(); dialog.SetupDialogWindow("Enter Folder Path", false); dialog.Content = pairBox; dialog.Closed += OnEnterFolderDialogClosed; dialog.Open(); } private void OnEnterFolderDialogClosed(NEventArgs arg) { NTopLevelWindow dialog = (NTopLevelWindow)arg.TargetNode; if (dialog.Result == ENWindowResult.OK) { NTextBox textBox = (NTextBox)dialog.Content.GetFirstDescendant(NTextBox.NTextBoxSchema); MergeAndSaveToFolder(textBox.Text); } } #endregion #region Fields private NRichTextView m_RichText; #endregion #region Static Methods private static NFieldInline CreateMailMergeField(NMailMergeFieldValue value) { NFieldInline fieldInline = new NFieldInline(value); fieldInline.FontStyle = ENFontStyle.Bold; return fieldInline; } #endregion #region Constants #endregion #region Nested Types #endregion } }

Download a fully functional C# (.cs) Mail Merge Example for WinForms Solution

VB.NET Mail Merge Example Code for Nevron RichTextEditor for WinForms
Language: VB.NET

Imports Nevron.Nov
Imports Nevron.Nov.Dom
Imports Nevron.Nov.Graphics
Imports Nevron.Nov.IO
Imports Nevron.Nov.Layout
Imports Nevron.Nov.Text
Imports Nevron.Nov.Text.Data
Imports Nevron.Nov.UI
Imports Nevron.Nov.Windows.Forms
Imports System.Globalization
Imports System.IO

Public Class Form1

#Region "Constructors"

    Public Sub New()
        ' This call is required by the designer.
        InitializeComponent()

        ' Add any initialization after the InitializeComponent() call.

        ' Set form title
        Text = "NOV WinForms - NMailMergeExample"

        ' Create the NOV example and its controls
        Dim exampleContent As NWidget = CreateExampleContent()
        Dim exampleControls As NWidget = CreateExampleControls()
        If Not exampleControls Is Nothing Then
            exampleControls.PreferredWidth = 300
        End If

        ' Place the example and its controls in a pair box
        Dim pairBox As NPairBox = New NPairBox(exampleContent, exampleControls)
        pairBox.FillMode = ENStackFillMode.First
        pairBox.FitMode = ENStackFitMode.First
        pairBox.Margins = New NMargins(NDesign.HorizontalSpacing, NDesign.VerticalSpacing)

        ' Host the example in the form
        Dim host As NNovWidgetHost(Of NWidget) = New NNovWidgetHost(Of NWidget)(pairBox)
        host.Dock = DockStyle.Fill
        Controls.Add(host)
    End Sub


#End Region

#Region "Example"

        Public Function CreateExampleContent() As NWidget
            ' Create the rich text
            Dim richTextWithRibbon As NRichTextViewWithRibbon = New NRichTextViewWithRibbon()
            m_RichText = richTextWithRibbon.View
            m_RichText.AcceptsTab = True
            m_RichText.Content.Sections.Clear()

            ' Populate the rich text
            PopulateRichText()

            Return richTextWithRibbon
        End Function
        Public Function CreateExampleControls() As NWidget
            Dim stack As NStackPanel = New NStackPanel()

            If NApplication.IntegrationPlatform IsNot ENIntegrationPlatform.Blazor Then
                Dim mergeAndSaveToFolderButton As NButton = New NButton("Merge & Save to Folder")
                mergeAndSaveToFolderButton.Click += AddressOf OnMergeAndSaveToFolderButtonClick
                stack.Add(mergeAndSaveToFolderButton)
            End If

            Return stack
        End Function
        Public Function GetExampleDescription() As String
            Dim previewMailMergeUri = NUriHelpers.CreateDataUriString(Nevron.Nov.Graphics.NImage.FromBytes(Nevron.Nov.NConvert.FromBase64String("iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAABrElEQVR4Ac2OA6ydQRBGt3Zj1LZt2whq2+bVM++zbdsIarsNaptBrdN/alsn+bLfcEf9EeydzFa29o7Y2DkgEu/g7GKtvgcbe8cr6enpfIzktNrVrw/bOVolpyQjLArdRGd9Cl0MKSwN24yQotVs7Z2s1MeMHTcBeS0srXny8B7LYnZTeOwO3Xr0oVXHXizLPM3K2D1Sw9LaBukdP2EiShg5crSYNuL1RhPCyIADtG3Tnvh95/HcdZ4qjdswOvAAgtFkgXpFm5ezfXr3fZNQ63QGePaYqcmXqVm3IVXqNqZqo2ZUbtCEaVpOajq96W3/m9k2LVu05M2Ca1cv47rrHqpkBXzOQdJjKFamIpK7duUyOqM10tuiZdu3l6s3ZvbceUFBwcHcun0H74OwapumreCl+Ztaztc/CGsnL96f+ZjKK1auvuXvH8Dpk8e4efUiIvE+vgGs1tny/PFt9np1RX2F5tOmzwpevnwVy5ateCXNL12pY2PEashuCA92stu7z1eXVJYTP1a6ZR+ehleHvFZs9RiA+gnaJFoMJsE0hCP+XTeqn+TNRXXUf8ELg3Iu6K3kg3kAAAAASUVORK5CYII=")))
            Return $"

This example demonstrates how to use the mail merge functionality of the Nevron Rich Text control.

Click the Preview Mail Merge button () from the Mailings ribbon tab to see the values for the currently selected mail merge record. When ready click the Merge & Save button to save all merged documents to a file.

The Merge & Save button saves each of the individual documents result of the mail merge operation to a folder.

" End Function ''' ''' Gets the relevant documentation links for the example ''' ''' Public Function GetDocumentationUrls() As (String, String)() Return {("Rich Text - Mail Merge Overview", "https://www.nevron.com/docs/openvision/rich-text-mail-merge-overview.html"), ("Rich Text - Mail Merge Fields", "https://www.nevron.com/docs/openvision/rich-text-mail-merge-fields.html"), ("Rich Text - Mail Merge Data Sources", "https://www.nevron.com/docs/openvision/rich-text-mail-merge-data-sources.html"), ("Rich Text Field Inlines", "https://www.nevron.com/docs/openvision/rich-text-field-inlines.html"), ("Data Sources", "https://www.nevron.com/docs/openvision/data-sources.html")} End Function Private Sub PopulateRichText() ' Create some text Dim documentBlock = m_RichText.Content documentBlock.Layout = ENTextLayout.Print Dim section As NSection = New NSection() documentBlock.Sections.Add(section) Dim paragraph As NParagraph = New NParagraph() paragraph.Inlines.Add(CreateMailMergeField(New NGreetingLineFieldValue())) section.Blocks.Add(paragraph) paragraph = New NParagraph() paragraph.Inlines.Add(New NTextInline("We would like to offer you a unique software component that will help you leverage multiple platforms with single code base. We believe that as a ")) paragraph.Inlines.Add(CreateMailMergeField(New NMailMergeSourceFieldValue("Title"))) paragraph.Inlines.Add(New NTextInline(" in your company you will be very interested in this solution. If that's the case do not hesitate to contact us in order to arrange a meeting in ")) paragraph.Inlines.Add(NMailMergeExample.CreateMailMergeField(New NMailMergePredefinedFieldValue(ENMailMergeDataField.City))) paragraph.Inlines.Add(New NTextInline(".")) section.Blocks.Add(paragraph) paragraph = New NParagraph() paragraph.Inlines.Add(New NTextInline("Best Regards,")) paragraph.Inlines.Add(New NLineBreakInline()) paragraph.Inlines.Add(New NTextInline("Nevron Software")) paragraph.Inlines.Add(New NLineBreakInline()) paragraph.Inlines.Add(New NFieldInline("www.nevron.com", New NUrlHyperlink("https://www.nevron.com"))) section.Blocks.Add(paragraph) ' Load a mail merge data source from resource Dim dataSource As NMailMergeDataSource Using stream As Stream = New MemoryStream(Nevron.Nov.NConvert.FromBase64String("RW1wbG95ZWVJRDtMYXN0TmFtZTtGaXJzdE5hbWU7VGl0bGU7VGl0bGVPZkNvdXJ0ZXN5O0JpcnRoRGF0ZTtIaXJlRGF0ZTtBZGRyZXNzO0NpdHk7UmVnaW9uO1Bvc3RhbENvZGU7Q291bnRyeTtIb21lUGhvbmU7RXh0ZW5zaW9uO1Bob3RvO05vdGVzO1JlcG9ydHNUbw0KMTtEYXZvbGlvO05hbmN5O1NhbGVzIFJlcHJlc2VudGF0aXZlO01zLjs4LjEyLjE5Njg7MS41LjE5OTI7IjUwNyAtIDIwdGggQXZlLiBFLg0KQXB0LiAyQSI7U2VhdHRsZTtXQTs5ODEyMjtVU0E7KDIwNikgNTU1LTk4NTc7NTQ2NztFbXBJRDEuYm1wOyJFZHVjYXRpb24gaW5jbHVkZXMgYSBCQSBpbiBwc3ljaG9sb2d5IGZyb20gQ29sb3JhZG8gU3RhdGUgVW5pdmVyc2l0eS4gIFNoZSBhbHNvIGNvbXBsZXRlZCAiIlRoZSBBcnQgb2YgdGhlIENvbGQgQ2FsbC4iIiAgTmFuY3kgaXMgYSBtZW1iZXIgb2YgVG9hc3RtYXN0ZXJzIEludGVybmF0aW9uYWwuIjsyDQoyO0Z1bGxlcjtBbmRyZXc7VmljZSBQcmVzaWRlbnQsIFNhbGVzO0RyLjsxOS4yLjE5NTI7MTQuOC4xOTkyOzkwOCBXLiBDYXBpdGFsIFdheTtUYWNvbWE7V0E7OTg0MDE7VVNBOygyMDYpIDU1NS05NDgyOzM0NTc7RW1wSUQyLmJtcDtBbmRyZXcgcmVjZWl2ZWQgaGlzIEJUUyBjb21tZXJjaWFsIGFuZCBhIFBoLkQuIGluIGludGVybmF0aW9uYWwgbWFya2V0aW5nIGZyb20gdGhlIFVuaXZlcnNpdHkgb2YgRGFsbGFzLiAgSGUgaXMgZmx1ZW50IGluIEZyZW5jaCBhbmQgSXRhbGlhbiBhbmQgcmVhZHMgR2VybWFuLiAgSGUgam9pbmVkIHRoZSBjb21wYW55IGFzIGEgc2FsZXMgcmVwcmVzZW50YXRpdmUsIHdhcyBwcm9tb3RlZCB0byBzYWxlcyBtYW5hZ2VyIGFuZCB3YXMgdGhlbiBuYW1lZCB2aWNlIHByZXNpZGVudCBvZiBzYWxlcy4gIEFuZHJldyBpcyBhIG1lbWJlciBvZiB0aGUgU2FsZXMgTWFuYWdlbWVudCBSb3VuZHRhYmxlLCB0aGUgU2VhdHRsZSBDaGFtYmVyIG9mIENvbW1lcmNlLCBhbmQgdGhlIFBhY2lmaWMgUmltIEltcG9ydGVycyBBc3NvY2lhdGlvbi47DQozO0xldmVybGluZztKYW5ldDtTYWxlcyBSZXByZXNlbnRhdGl2ZTtNcy47MzAuOC4xOTYzOzEuNC4xOTkyOzcyMiBNb3NzIEJheSBCbHZkLjtLaXJrbGFuZDtXQTs5ODAzMztVU0E7KDIwNikgNTU1LTM0MTI7MzM1NTtFbXBJRDMuYm1wO0phbmV0IGhhcyBhIEJTIGRlZ3JlZSBpbiBjaGVtaXN0cnkgZnJvbSBCb3N0b24gQ29sbGVnZSkuICBTaGUgaGFzIGFsc28gY29tcGxldGVkIGEgY2VydGlmaWNhdGUgcHJvZ3JhbSBpbiBmb29kIHJldGFpbGluZyBtYW5hZ2VtZW50LiAgSmFuZXQgd2FzIGhpcmVkIGFzIGEgc2FsZXMgYXNzb2NpYXRlIGFuZCB3YXMgcHJvbW90ZWQgdG8gc2FsZXMgcmVwcmVzZW50YXRpdmUuOzINCjQ7UGVhY29jaztNYXJnYXJldDtTYWxlcyBSZXByZXNlbnRhdGl2ZTtNcnMuOzE5LjkuMTk1ODszLjUuMTk5Mzs0MTEwIE9sZCBSZWRtb25kIFJkLjtSZWRtb25kO1dBOzk4MDUyO1VTQTsoMjA2KSA1NTUtODEyMjs1MTc2O0VtcElENC5ibXA7TWFyZ2FyZXQgaG9sZHMgYSBCQSBpbiBFbmdsaXNoIGxpdGVyYXR1cmUgZnJvbSBDb25jb3JkaWEgQ29sbGVnZSBhbmQgYW4gTUEgZnJvbSB0aGUgQW1lcmljYW4gSW5zdGl0dXRlIG9mIEN1bGluYXJ5IEFydHMuIFNoZSB3YXMgdGVtcG9yYXJpbHkgYXNzaWduZWQgdG8gdGhlIExvbmRvbiBvZmZpY2UgYmVmb3JlIHJldHVybmluZyB0byBoZXIgcGVybWFuZW50IHBvc3QgaW4gU2VhdHRsZS47Mg0KNTtCdWNoYW5hbjtTdGV2ZW47U2FsZXMgTWFuYWdlcjtNci47NC4zLjE5NTU7MTcuMTAuMTk5MzsxNCBHYXJyZXR0IEhpbGw7TG9uZG9uOztTVzEgOEpSO1VLOyg3MSkgNTU1LTQ4NDg7MzQ1MztFbXBJRDUuYm1wOyJTdGV2ZW4gQnVjaGFuYW4gZ3JhZHVhdGVkIGZyb20gU3QuIEFuZHJld3MgVW5pdmVyc2l0eSwgU2NvdGxhbmQsIHdpdGggYSBCU0MgZGVncmVlLiAgVXBvbiBqb2luaW5nIHRoZSBjb21wYW55IGFzIGEgc2FsZXMgcmVwcmVzZW50YXRpdmUsIGhlIHNwZW50IDYgbW9udGhzIGluIGFuIG9yaWVudGF0aW9uIHByb2dyYW0gYXQgdGhlIFNlYXR0bGUgb2ZmaWNlIGFuZCB0aGVuIHJldHVybmVkIHRvIGhpcyBwZXJtYW5lbnQgcG9zdCBpbiBMb25kb24sIHdoZXJlIGhlIHdhcyBwcm9tb3RlZCB0byBzYWxlcyBtYW5hZ2VyLiAgTXIuIEJ1Y2hhbmFuIGhhcyBjb21wbGV0ZWQgdGhlIGNvdXJzZXMgIiJTdWNjZXNzZnVsIFRlbGVtYXJrZXRpbmciIiBhbmQgIiJJbnRlcm5hdGlvbmFsIFNhbGVzIE1hbmFnZW1lbnQuIiIgIEhlIGlzIGZsdWVudCBpbiBGcmVuY2guIjsyDQo2O1N1eWFtYTtNaWNoYWVsO1NhbGVzIFJlcHJlc2VudGF0aXZlO01yLjsyLjcuMTk2MzsxNy4xMC4xOTkzOyJDb3ZlbnRyeSBIb3VzZQ0KTWluZXIgUmQuIjtMb25kb247O0VDMiA3SlI7VUs7KDcxKSA1NTUtNzc3Mzs0Mjg7RW1wSUQ2LmJtcDsiTWljaGFlbCBpcyBhIGdyYWR1YXRlIG9mIFN1c3NleCBVbml2ZXJzaXR5IChNQSwgZWNvbm9taWNzKSBhbmQgdGhlIFVuaXZlcnNpdHkgb2YgQ2FsaWZvcm5pYSBhdCBMb3MgQW5nZWxlcyAoTUJBLCBtYXJrZXRpbmcpLiAgSGUgaGFzIGFsc28gdGFrZW4gdGhlIGNvdXJzZXMgIiJNdWx0aS1DdWx0dXJhbCBTZWxsaW5nIiIgYW5kICIiVGltZSBNYW5hZ2VtZW50IGZvciB0aGUgU2FsZXMgUHJvZmVzc2lvbmFsLiIiICBIZSBpcyBmbHVlbnQgaW4gSmFwYW5lc2UgYW5kIGNhbiByZWFkIGFuZCB3cml0ZSBGcmVuY2gsIFBvcnR1Z3Vlc2UsIGFuZCBTcGFuaXNoLiI7NQ0KNztLaW5nO1JvYmVydDtTYWxlcyBSZXByZXNlbnRhdGl2ZTtNci47MjkuNS4xOTYwOzIuMS4xOTk0OyJFZGdlaGFtIEhvbGxvdw0KV2luY2hlc3RlciBXYXkiO0xvbmRvbjs7UkcxIDlTUDtVSzsoNzEpIDU1NS01NTk4OzQ2NTtFbXBJRDcuYm1wOyJSb2JlcnQgS2luZyBzZXJ2ZWQgaW4gdGhlIFBlYWNlIENvcnBzIGFuZCB0cmF2ZWxlZCBleHRlbnNpdmVseSBiZWZvcmUgY29tcGxldGluZyBoaXMgZGVncmVlIGluIEVuZ2xpc2ggYXQgdGhlIFVuaXZlcnNpdHkgb2YgTWljaGlnYW4gYW5kIHRoZW4gam9pbmluZyB0aGUgY29tcGFueS4gIEFmdGVyIGNvbXBsZXRpbmcgYSBjb3Vyc2UgZW50aXRsZWQgIiJTZWxsaW5nIGluIEV1cm9wZSwiIiBoZSB3YXMgdHJhbnNmZXJyZWQgdG8gdGhlIExvbmRvbiBvZmZpY2UuIjs1DQo4O0NhbGxhaGFuO0xhdXJhO0luc2lkZSBTYWxlcyBDb29yZGluYXRvcjtNcy47OS4xLjE5NTg7NS4zLjE5OTQ7NDcyNiAtIDExdGggQXZlLiBOLkUuO1NlYXR0bGU7V0E7OTgxMDU7VVNBOygyMDYpIDU1NS0xMTg5OzIzNDQ7RW1wSUQ4LmJtcDtMYXVyYSByZWNlaXZlZCBhIEJBIGluIHBzeWNob2xvZ3kgZnJvbSB0aGUgVW5pdmVyc2l0eSBvZiBXYXNoaW5ndG9uLiAgU2hlIGhhcyBhbHNvIGNvbXBsZXRlZCBhIGNvdXJzZSBpbiBidXNpbmVzcyBGcmVuY2guICBTaGUgcmVhZHMgYW5kIHdyaXRlcyBGcmVuY2guOzINCjk7RG9kc3dvcnRoO0FubmU7U2FsZXMgUmVwcmVzZW50YXRpdmU7TXMuOzIuNy4xOTY5OzE1LjExLjE5OTQ7NyBIb3VuZHN0b290aCBSZC47TG9uZG9uOztXRzIgN0xUO1VLOyg3MSkgNTU1LTQ0NDQ7NDUyO0VtcElEOS5ibXA7QW5uZSBoYXMgYSBCQSBkZWdyZWUgaW4gRW5nbGlzaCBmcm9tIFN0LiBMYXdyZW5jZSBDb2xsZWdlLiAgU2hlIGlzIGZsdWVudCBpbiBGcmVuY2ggYW5kIEdlcm1hbi47NQ0K")) dataSource = NDataSourceFormat.Csv.LoadFromStream(stream, New NDataSourceLoadSettings(Nothing, Nothing, True)) End Using ' Create the field mappings Dim fieldMap As NMailMergeFieldMap = New NMailMergeFieldMap() fieldMap.[Set](ENMailMergeDataField.CourtesyTitle, "TitleOfCourtesy") fieldMap.[Set](ENMailMergeDataField.FirstName, "FirstName") fieldMap.[Set](ENMailMergeDataField.LastName, "LastName") fieldMap.[Set](ENMailMergeDataField.City, "City") dataSource.FieldMap = fieldMap documentBlock.MailMerge.DataSource = dataSource End Sub #End Region #Region "Implementation" Private Sub MergeAndSaveToFolder(targetPath As String) Dim folder = NFileSystem.Current.GetFolder(targetPath) If folder Is Nothing Then NMessageBox.Show("The entered target path does not exist", "Error", ENMessageBoxButtons.OK, ENMessageBoxIcon.Error) Return End If ' Clone the rich text view Dim clonedRichTextView As NRichTextView = CType(m_RichText.DeepClone(), NRichTextView) ' Switch the mail merge of the cloned rich text view to preview mode Dim mailMerge = clonedRichTextView.Content.MailMerge mailMerge.PreviewMailMerge = True ' Loop through all mail merge records to save individual documents to file For i = 0 To mailMerge.DataRecordCount - 1 ' Move to the next data source record mailMerge.CurrentDataRecordIndex = i ' Save the merged document to file Dim fileName = "Document" & i.ToString(CultureInfo.InvariantCulture) & ".docx" clonedRichTextView.SaveToFileAsync(NPath.Current.Combine(targetPath, fileName)) Next NMessageBox.Show("Merged documents saved to """ & targetPath & """.", "Mail Merge Complete", ENMessageBoxButtons.OK, ENMessageBoxIcon.Information) End Sub #End Region #Region "Event Handlers" Private Sub OnMergeAndSaveToFolderButtonClick(arg As NEventArgs) Dim textBox As NTextBox = New NTextBox() Dim buttonStrip As NButtonStrip = New NButtonStrip() buttonStrip.AddOKCancelButtons() Dim pairBox As NPairBox = New NPairBox(textBox, buttonStrip, ENPairBoxRelation.Box1AboveBox2) Dim dialog As NTopLevelWindow = NApplication.CreateTopLevelWindow() dialog.SetupDialogWindow("Enter Folder Path", False) dialog.Content = pairBox dialog.Closed += AddressOf OnEnterFolderDialogClosed dialog.Open() End Sub Private Sub OnEnterFolderDialogClosed(arg As NEventArgs) Dim dialog = CType(arg.TargetNode, NTopLevelWindow) If dialog.Result Is ENWindowResult.OK Then Dim textBox = CType(dialog.Content.GetFirstDescendant(NTextBox.NTextBoxSchema), NTextBox) MergeAndSaveToFolder(textBox.Text) End If End Sub #End Region #Region "Fields" Private m_RichText As NRichTextView #End Region #Region "Static Methods" Private Shared Function CreateMailMergeField(value As NMailMergeFieldValue) As NFieldInline Dim fieldInline As NFieldInline = New NFieldInline(value) fieldInline.FontStyle = ENFontStyle.Bold Return fieldInline End Function #End Region #Region "Constants" #End Region #Region "Nested Types" #End Region End Class

Download a fully functional VB.NET (.vb) Mail Merge Example for WinForms Solution