Word Processing Document API - Embed Images into a Mail Merge Template

C#
using DevExpress.Office.Services;
using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;
using System;
using System.Diagnostics;
using System.Windows.Forms;

namespace RichEditImageMailMerge {
    static class Program {
        /// <summary>
        /// The main entry point for the application.
        /// </summary>
        [STAThread]
        static void Main() {

            using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
            {
                RegisterUriStreamService(wordProcessor);
                wordProcessor.LoadDocument(Application.StartupPath + @"MailMergeTemplate.rtf");
                wordProcessor.Options.MailMerge.DataSource = NorthwindDataProvider.Categories;
                wordProcessor.Options.MailMerge.ViewMergedData = true;
                MergeToNewDocument(wordProcessor);
            }
        }

        #region #registerprovider
        private static void RegisterUriStreamService(RichEditDocumentServer richEditDocumentServer)
        {
            IUriStreamService uriStreamService = richEditDocumentServer.GetService<IUriStreamService>();
            uriStreamService.RegisterProvider(new ImageStreamProvider(NorthwindDataProvider.Categories, "Picture"));
        }
        #endregion #registerprovider
        #region Mail-merge the document

        private static void MergeToNewDocument(RichEditDocumentServer richEditDocumentServer)
        {
            MailMergeOptions options = richEditDocumentServer.Document.CreateMailMergeOptions();
            options.MergeMode = MergeMode.NewSection;
            string fileName = System.IO.Directory.GetCurrentDirectory() + @"MailMergeResult.rtf";

            richEditDocumentServer.Document.MailMerge(options, fileName, DocumentFormat.Rtf);

            var p = new Process();
            p.StartInfo = new ProcessStartInfo(fileName)
            {
                UseShellExecute = true
            };
            p.Start();
        }
        #endregion Mail-merge the document
    }
}

Visual Basic
Imports DevExpress.Office.Services
Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native
Imports System.Windows.Forms

Namespace RichEditImageMailMerge
    Friend Module Program
        ''' <summary>
        ''' The main entry point for the application.
        ''' </summary>
        <STAThread>
        Sub Main()
            Using wordProcessor As New RichEditDocumentServer()
                RegisterUriStreamService(wordProcessor)
                wordProcessor.LoadDocument(Application.StartupPath & "\MailMergeTemplate.rtf")
                wordProcessor.Options.MailMerge.DataSource = NorthwindDataProvider.Categories
                wordProcessor.Options.MailMerge.ViewMergedData = True
                MergeToNewDocument(wordProcessor)
            End Using
        End Sub

#Region "registerprovider"
        Private Sub RegisterUriStreamService(richEditDocumentServer As RichEditDocumentServer)
            Dim uriStreamService As IUriStreamService = richEditDocumentServer.GetService(Of IUriStreamService)()
            uriStreamService.RegisterProvider(New ImageStreamProvider(NorthwindDataProvider.Categories, "Picture"))
        End Sub
#End Region

#Region "Mail-merge the document"
        Private Sub MergeToNewDocument(richEditDocumentServer As RichEditDocumentServer)
            Dim options As MailMergeOptions = richEditDocumentServer.Document.CreateMailMergeOptions()
            options.MergeMode = MergeMode.NewSection
            Dim fileName As String = System.IO.Directory.GetCurrentDirectory() & "\MailMergeResult.rtf"

            richEditDocumentServer.Document.MailMerge(options, fileName, DocumentFormat.Rtf)

            Dim p As New Process()
            p.StartInfo = New ProcessStartInfo(fileName) With {
                .UseShellExecute = True
            }
            p.Start()
        End Sub
#End Region
    End Module
End Namespace

C#
using System.IO;
using System.Data;
using DevExpress.Office.Services;

namespace RichEditImageMailMerge {
#region #iuristreamprovider
    public class ImageStreamProvider : IUriStreamProvider {
        static readonly string prefix = "dbimg://";
        DataTable table;
        string columnName;

        public ImageStreamProvider(DataTable sourceTable, string imageColumn) {
            this.table = sourceTable;
            this.columnName = imageColumn;
        }


        public Stream GetStream(string uri) {
            uri = uri.Trim();
            if (!uri.StartsWith(prefix))
                return null;
            string strId = uri.Substring(prefix.Length).Trim();
            int id;
            if (!int.TryParse(strId, out id))
                return null;
            DataRow row = table.Rows.Find(id);
            if (row == null)
                return null;
            byte[] bytes = row[columnName] as byte[];
            if (bytes == null)
                return null;

            MemoryStream memoryStream = new MemoryStream(bytes);
            return memoryStream;
        }

#endregion #iuristreamprovider
    }
}

Visual Basic
Imports System.IO
Imports System.Data
Imports DevExpress.Office.Services

Namespace RichEditImageMailMerge

'#Region "#iuristreamprovider"
    Public Class ImageStreamProvider
        Implements IUriStreamProvider

        Private Shared ReadOnly prefix As String = "dbimg://"

        Private table As DataTable

        Private columnName As String

        Public Sub New(ByVal sourceTable As DataTable, ByVal imageColumn As String)
            table = sourceTable
            columnName = imageColumn
        End Sub

        Public Function GetStream(ByVal uri As String) As Stream Implements IUriStreamProvider.GetStream
            uri = uri.Trim()
            If Not uri.StartsWith(prefix) Then Return Nothing
            Dim strId As String = uri.Substring(prefix.Length).Trim()
            Dim id As Integer
            If Not Integer.TryParse(strId, id) Then Return Nothing
            Dim row As DataRow = table.Rows.Find(id)
            If row Is Nothing Then Return Nothing
            Dim bytes As Byte() = TryCast(row(columnName), Byte())
            If bytes Is Nothing Then Return Nothing

            Dim memoryStream As MemoryStream = New MemoryStream(bytes)
            Return memoryStream
        End Function
'#End Region  ' #iuristreamprovider
    End Class
End Namespace

C#
using System.Data;
using System.Data.OleDb;

namespace RichEditImageMailMerge {
    public static class NorthwindDataProvider {
        private static string connectionString = @"Provider=Microsoft.ACE.OLEDB.12.0;Data Source=|DataDirectory|\nwind.mdb;Persist Security Info=False;";

        static NorthwindDataProvider() {
            using (OleDbConnection connection = new OleDbConnection(connectionString)) {
                OleDbCommand selectCommand = new OleDbCommand("SELECT * FROM Categories", connection);
                OleDbDataAdapter da = new OleDbDataAdapter(selectCommand);

                categories = new DataTable("Categories");

                da.Fill(categories);

                categories.Constraints.Add("IDPK", categories.Columns["CategoryID"], true);
 
                selectCommand.Dispose();
            }
        }

        private static DataTable categories;

        public static DataTable Categories {
            get {
                return categories;
            }
        }
    }
}

Visual Basic
Imports System.Data
Imports System.Data.OleDb

Namespace RichEditImageMailMerge

    Public Module NorthwindDataProvider

        Private connectionString As String = "Provider=Microsoft.ACE.OLEDB.12.0;Data Source=|DataDirectory|\nwind.mdb;Persist Security Info=False;"

        Sub New()
            Using connection As OleDbConnection = New OleDbConnection(connectionString)
                Dim selectCommand As OleDbCommand = New OleDbCommand("SELECT * FROM Categories", connection)
                Dim da As OleDbDataAdapter = New OleDbDataAdapter(selectCommand)
                categoriesField = New DataTable("Categories")
                da.Fill(categoriesField)
                categoriesField.Constraints.Add("IDPK", categoriesField.Columns("CategoryID"), True)
                selectCommand.Dispose()
            End Using
        End Sub

        Private categoriesField As DataTable

        Public ReadOnly Property Categories As DataTable
            Get
                Return categoriesField
            End Get
        End Property
    End Module
End Namespace