Get merge fields

The example shows you how to retrieve all merge fields from a document and display their names and values.

C# example

using System;
using System.Collections.Generic;
using Independentsoft.Office;
using Independentsoft.Office.Word;
using Independentsoft.Office.Word.Fields;

namespace Sample
{
    class Program
    {
        static void Main(string[] args)
        {
            WordDocument doc = new WordDocument("c:\\test\\input.docx");

            IList<IContentElement> docElements = doc.GetContentElements();

            foreach (IContentElement docElement in docElements)
            {
                if (docElement is SimpleField)
                {
                    SimpleField simpleField = (SimpleField)docElement;

                    if (simpleField.Field is MergeField)
                    {
                        MergeField mergeField = (MergeField)simpleField.Field;
                        
                        string fieldValue = "";

                        IList<IContentElement> simpleFieldElements = simpleField.GetContentElements();

                        foreach(IContentElement element in simpleFieldElements)
                        {
                            if(element is Text)
                            {
                                Text text = (Text)element;
                                fieldValue += text.Value;
                            }
                        }

                        Console.WriteLine("MergeField name = " + mergeField.Name);
                        Console.WriteLine("MergeField value = " + fieldValue);
                    }
                }
            }

            Console.Read();
        }
    }
}

VB example

Imports System
Imports System.Collections.Generic
Imports Independentsoft.Office
Imports Independentsoft.Office.Word
Imports Independentsoft.Office.Word.Fields

Module Module1
    Sub Main(ByVal args As String())

        Dim doc As WordDocument = New WordDocument("c:\test\input.docx")

        Dim docElements As IList(Of IContentElement) = doc.GetContentElements()

        For Each docElement As IContentElement In docElements
            If TypeOf docElement Is SimpleField Then
                Dim simpleField As SimpleField = DirectCast(docElement, SimpleField)

                If TypeOf simpleField.Field Is MergeField Then
                    Dim mergeField As MergeField = DirectCast(simpleField.Field, MergeField)

                    Dim fieldValue As String = ""

                    Dim simpleFieldElements As IList(Of IContentElement) = simpleField.GetContentElements()

                    For Each element As IContentElement In simpleFieldElements
                        If TypeOf element Is Text Then
                            Dim text As Text = DirectCast(element, Text)
                            fieldValue += text.Value
                        End If
                    Next

                    Console.WriteLine("MergeField name = " + mergeField.Name)
                    Console.WriteLine("MergeField value = " + fieldValue)
                End If
            End If
        Next

        Console.Read()

    End Sub
End Module

Independentsoft - any library, any programming language

Word .NET > Tutorial > Get merge fields

Need help? Ask our developers: