LibreDocuments 1.1.6

LibreDocuments

LibreDocuments is a .NET library for updating .docx templates with placeholder values, embedding fonts, and generating page footer content using Open XML.

Package Links

• NuGet package: https://www.nuget.org/packages/LibreDocuments
• Release notes / changelog: https://www.nuget.org/packages/LibreDocuments#versions-body-tab
• License: LICENSE.txt

Versioning

• Latest stable version is shown on the NuGet badge above.
• Follow semantic versioning for package updates:
  • Patch (x.y.Z): bug fixes, no API break
  • Minor (x.Y.z): backward-compatible new features
  • Major (X.y.z): breaking API changes

Features

• Replace placeholders in document body text.
• Replace placeholders across split runs in body/header/footer.
• Embed a custom font into the Word file.
• Add or update footer page numbering content.

Installation

dotnet add package LibreDocuments

Supported Frameworks

• netstandard2.0
• net8.0

API

void GenerateWord(
    string outputDocxPath,
    string fontPath,
    string fontName,
    int fontSize,
    Dictionary<string, string> paraBody,
    Dictionary<string, string> paraHeader,
    Dictionary<string, string> paraFooter
)

Quick Start

using LibreDoc;
using System;
using System.Collections.Generic;

string tempDocxPath = @"C:\Docs\Template.docx";
string fontPath = @"C:\Fonts\THSarabunNew.ttf";
string fontName = "TH Sarabun New";
int fontSize = 16;

var paraBody = new Dictionary<string, string>
{
    ["{FullName}"] = "John Doe",
    ["{DocDate}"] = DateTime.Now.ToString("yyyy-MM-dd"),
    ["{Department}"] = "Finance"
};

var paraHeader = new Dictionary<string, string>
{
    ["{HeaderTitle}"] = "Monthly Report",
    ["{HeaderCode}"] = "RPT-2026-04"
};

var paraFooter = new Dictionary<string, string>
{
    // Page text pieces
    ["{PageFirstText}"] = "Page ",
    ["{PageSeparator}"] = " / ",
    ["{PageLastText}"] = " Total",

    // Footer layout switches
    // Empty = standard right footer
    // Non-empty = left/center-aware footer layout
    ["{ParameterLeft}"] = "",
    ["{ParameterCenter}"] = ""
};

var doc = new LibreDocuments();
doc.GenerateWord(
    tempDocxPath,
    fontPath,
    fontName,
    fontSize,
    paraBody,
    paraHeader,
    paraFooter
);

Placeholder Conventions

• Use consistent keys in your template and dictionaries, e.g. {FullName}, {DocDate}.
• Matching is exact and case-sensitive.
• For best results, keep placeholder format consistent across body/header/footer.

Footer Behavior

• If paraFooter["{ParameterLeft}"] is empty, standard footer mode is used.
• If paraFooter["{ParameterLeft}"] is not empty, parameterized footer mode is used.
• "{PageFirstText}", "{PageSeparator}", and "{PageLastText}" control page label text around PAGE/NUMPAGES fields.

Error Notes

• Throws FileNotFoundException when outputDocxPath does not exist.
• Make sure fontPath points to a valid readable font file.
• If placeholders are not replaced, verify key spelling/casing in both template and dictionary.

Publish to NuGet.org

dotnet build -c Release
dotnet nuget push .\bin\Release\LibreDocuments.<version>.nupkg --api-key <YOUR_API_KEY> --source https://api.nuget.org/v3/index.json