1. Home
  2. /
  3. GroupDocs.Merger.LowCode
  4. /
  5. Developer Guide
  6. /
  7. Merge DOCX (JoinDocx)

Using JoinDocx to Merge DOCX Documents

On this page

This topic shows how to use the JoinDocx plugin to merge Word documents in the DOCX format. JoinDocx takes a source DOCX document and appends other DOCX documents to it, in the order you list them.

Prerequisites

Refer to the Developer Guide to learn how to set up your environment and run the code examples in this section.

The Loading Source Documents and Saving Output Documents topics explain how to specify input and output documents.

Basic Example

The following example appends the second chapter of a business plan to the first one. The documents are loaded from the current folder, and the merged document is saved to the output folder.

using System;
using GroupDocs.Merger.Domain.Options;
using GroupDocs.Merger.LowCode;

// Load license keys
var publicKey = Environment.GetEnvironmentVariable("GD_PUBLIC_KEY");
var privateKey = Environment.GetEnvironmentVariable("GD_PRIVATE_KEY");

// Apply the license
License.Set(publicKey, privateKey);

// Append the documents to the source document
var merger = new JoinDocx("chapter-1.docx", new[] { "chapter-2.docx" }, new JoinOptions());

// Save the merged document
merger.Save("output/chapters-1-2.docx");
Imports System
Imports GroupDocs.Merger.Domain.Options
Imports GroupDocs.Merger.LowCode

Module Program
    Sub Main()
        ' Load license keys
        Dim publicKey = Environment.GetEnvironmentVariable("GD_PUBLIC_KEY")
        Dim privateKey = Environment.GetEnvironmentVariable("GD_PRIVATE_KEY")

        ' Apply the license
        License.Set(publicKey, privateKey)

        ' Append the documents to the source document
        Dim merger As New JoinDocx("chapter-1.docx", {"chapter-2.docx"}, New JoinOptions())

        ' Save the merged document
        merger.Save("output/chapters-1-2.docx")
    End Sub
End Module
open System
open GroupDocs.Merger.Domain.Options
open GroupDocs.Merger.LowCode

[<EntryPoint>]
let main _ =
    // Load license keys
    let publicKey = Environment.GetEnvironmentVariable("GD_PUBLIC_KEY")
    let privateKey = Environment.GetEnvironmentVariable("GD_PRIVATE_KEY")

    // Apply the license
    License.Set(publicKey, privateKey)

    // Append the documents to the source document
    let merger = JoinDocx("chapter-1.docx", [ "chapter-2.docx" ], JoinOptions())

    // Save the merged document
    merger.Save("output/chapters-1-2.docx")
    0

Sample input: Download chapter-1.docx

Sample input: Download chapter-2.docx

Expected output: Download chapters-1-2.docx

Merge Multiple DOCX Documents

Pass as many documents as you need. They are appended to the source document in the order of the list. The following example merges three chapters into one document.

using System;
using GroupDocs.Merger.Domain.Options;
using GroupDocs.Merger.LowCode;

// Load license keys
var publicKey = Environment.GetEnvironmentVariable("GD_PUBLIC_KEY");
var privateKey = Environment.GetEnvironmentVariable("GD_PRIVATE_KEY");

// Apply the license
License.Set(publicKey, privateKey);

// Append the documents to the source document
var merger = new JoinDocx("chapter-1.docx", new[] { "chapter-2.docx", "chapter-3.docx" }, new JoinOptions());

// Save the merged document
merger.Save("output/merged-chapters.docx");
Imports System
Imports GroupDocs.Merger.Domain.Options
Imports GroupDocs.Merger.LowCode

Module Program
    Sub Main()
        ' Load license keys
        Dim publicKey = Environment.GetEnvironmentVariable("GD_PUBLIC_KEY")
        Dim privateKey = Environment.GetEnvironmentVariable("GD_PRIVATE_KEY")

        ' Apply the license
        License.Set(publicKey, privateKey)

        ' Append the documents to the source document
        Dim merger As New JoinDocx("chapter-1.docx", {"chapter-2.docx", "chapter-3.docx"}, New JoinOptions())

        ' Save the merged document
        merger.Save("output/merged-chapters.docx")
    End Sub
End Module
open System
open GroupDocs.Merger.Domain.Options
open GroupDocs.Merger.LowCode

[<EntryPoint>]
let main _ =
    // Load license keys
    let publicKey = Environment.GetEnvironmentVariable("GD_PUBLIC_KEY")
    let privateKey = Environment.GetEnvironmentVariable("GD_PRIVATE_KEY")

    // Apply the license
    License.Set(publicKey, privateKey)

    // Append the documents to the source document
    let merger = JoinDocx("chapter-1.docx", [ "chapter-2.docx"; "chapter-3.docx" ], JoinOptions())

    // Save the merged document
    merger.Save("output/merged-chapters.docx")
    0

Sample input: Download chapter-1.docx

Sample input: Download chapter-2.docx

Sample input: Download chapter-3.docx

Expected output: Download merged-chapters.docx

Merge DOCX Documents from a Stream

The source document can also be a Stream; the documents to append are always file paths. The stream is read from the beginning, and it stays open after Save.

using System;
using System.IO;
using GroupDocs.Merger.Domain.Options;
using GroupDocs.Merger.LowCode;

// Load license keys
var publicKey = Environment.GetEnvironmentVariable("GD_PUBLIC_KEY");
var privateKey = Environment.GetEnvironmentVariable("GD_PRIVATE_KEY");

// Apply the license
License.Set(publicKey, privateKey);

// Open the source document as a stream
using var stream = File.OpenRead("chapter-1.docx");

// Append the documents to the source document
var merger = new JoinDocx(stream, new[] { "chapter-2.docx" }, new JoinOptions());

// Save the merged document
merger.Save("output/chapters-1-2.docx");
Imports System
Imports System.IO
Imports GroupDocs.Merger.Domain.Options
Imports GroupDocs.Merger.LowCode

Module Program
    Sub Main()
        ' Load license keys
        Dim publicKey = Environment.GetEnvironmentVariable("GD_PUBLIC_KEY")
        Dim privateKey = Environment.GetEnvironmentVariable("GD_PRIVATE_KEY")

        ' Apply the license
        License.Set(publicKey, privateKey)

        ' Open the source document as a stream
        Using stream = File.OpenRead("chapter-1.docx")
            ' Append the documents to the source document
            Dim merger As New JoinDocx(stream, {"chapter-2.docx"}, New JoinOptions())

            ' Save the merged document
            merger.Save("output/chapters-1-2.docx")
        End Using
    End Sub
End Module
open System
open System.IO
open GroupDocs.Merger.Domain.Options
open GroupDocs.Merger.LowCode

[<EntryPoint>]
let main _ =
    // Load license keys
    let publicKey = Environment.GetEnvironmentVariable("GD_PUBLIC_KEY")
    let privateKey = Environment.GetEnvironmentVariable("GD_PRIVATE_KEY")

    // Apply the license
    License.Set(publicKey, privateKey)

    // Open the source document as a stream
    use stream = File.OpenRead("chapter-1.docx")

    // Append the documents to the source document
    let merger = JoinDocx(stream, [ "chapter-2.docx" ], JoinOptions())

    // Save the merged document
    merger.Save("output/chapters-1-2.docx")
    0

Sample input: Download chapter-1.docx

Sample input: Download chapter-2.docx

Expected output: Download chapters-1-2.docx

On this page