Universal.Frameworks.Documents 1.0.0

Universal.Frameworks.Documents

This library provides classes that render dynamic OpenXml word processing documents from a template document. The template document must provide fields with unique tags which indicate where in the document data elements are mapped. This article by Microsoft provides detailed instructions on how to set up your Microsoft Word environment to create such form fields.

Note

If you have issues with not being able to exit Design Mode, ensure that there are no empty placeholders in any form fields. They must contain at least one character and a space ' ' is recommended if the default text is undesirable.

Validating a Template

You can validate a provided OpenXML word processing document by using the provided DocumentTemplateValidator class.

It provides the option of validating the template itself through the one-parameter overload:

DocumentTemplateValidator templateValidator = new DocumentTemplateValidator();
DocumentTemplateValidationResult validationResult = templateValidator.Validate(@"MyDocumentTemplate.docx");

It also provides the ability to validate the template against an existing set of data elements, highlighting issues where an element is provided for an identifier but it doesn't exist in the document.

DataElement[] problemElements = new DataElement[]
{
    new DataElement
    {
        Identifier = "DoesNotExist"
    }
};
DocumentTemplateValidationResult problemValidationResult = templateValidator.Validate(@"MyDocumentTemplate.docx", problemElements);

Creating a Renderer

You can configure an create a renderer using the provided DocumentRendererBuilder class.

DocumentRenderer renderer = new DocumentRendererBuilder()
    .AddDefaultDataElementRenderers()
    .WithReferenceElementFinder(new TagDataElementReferenceElementFinder())
    .Build();

Calling the Render method overload with the template document stream is all that is required to create a render the elements into an in-memory copy of the document, which can then be written out to a file.

using (Stream outputStream = renderer.Render(File.OpenRead(@"MyDocumentTemplate.docx"), elements))
using (FileStream fileStream = File.Create("Out.docx"))
{
    outputStream.CopyTo(fileStream);
}