open xml how to add shape to footer in word

Breiz Heurope

3 min read

·

10-03-2025

1

0

Share

Adding shapes to the footer of a Word document using Open XML might seem daunting, but with a structured approach and understanding of the XML structure, it becomes manageable. This article provides a comprehensive guide, walking you through the process step-by-step. We will focus on using C#, but the underlying Open XML concepts are applicable to other languages.

Understanding the Open XML Structure

Before diving into code, it's crucial to understand the fundamental structure of an Open XML Word document. The document is essentially a collection of XML files zipped together. The footer resides within the footer element, which itself is nested within the document's structure. We'll need to navigate this structure to add our shape.

Setting up Your Environment

To follow along, you'll need:

• Visual Studio: (or your preferred C# IDE)
• DocumentFormat.OpenXml NuGet Package: This package provides the necessary classes for working with Open XML. Install it via the NuGet Package Manager in Visual Studio.

Code Example: Adding a Shape to the Footer

This C# code snippet demonstrates adding a rectangle shape to the first page's footer. You can adapt it to add other shapes and modify properties as needed.

using DocumentFormat.OpenXml.Packaging;
using DocumentFormat.OpenXml.Wordprocessing;
using DocumentFormat.OpenXml.Drawing;
using DocumentFormat.OpenXml.Drawing.Wordprocessing;
using A = DocumentFormat.OpenXml.Drawing;
using DW = DocumentFormat.OpenXml.Drawing.Wordprocessing;


public static void AddShapeToFooter(string filePath)
{
    using (WordprocessingDocument document = WordprocessingDocument.Open(filePath, true))
    {
        // Get the main document part
        MainDocumentPart mainPart = document.MainDocumentPart;

        // Get the footer part (create if it doesn't exist)
        FooterPart footerPart = mainPart.FooterParts.FirstOrDefault();
        if (footerPart == null)
        {
            footerPart = mainPart.AddNewPart<FooterPart>();
            footerPart.Footer = new Footer();
        }

        // Add a simple rectangle shape
        var shape = new A.Shape()
        {
            Id = (UInt32Value)1U, // Assign a unique ID
            Type = "rect" // Specifies rectangle shape
        };

        // Add styling to the rectangle (adjust as needed)
        shape.Append(new A.NonVisualShapeProperties(
            new A.NonVisualDrawingProperties() { Id = (UInt32Value)1U, Name = "Rectangle" },
            new A.NonVisualShapeDrawingProperties()));
        shape.Append(new A.ShapeProperties(
            new A.Transform2D(
                new A.Offset { X = "0", Y = "0" },
                new A.Extents { Cx = 9525000L, Cy = 9525000L }), // Adjust size as needed. 9525000L corresponds to approximately 9.525 cm
            new A.PresetGeometry { Preset = "rectangle" }));


        // Add the shape to the footer content
        footerPart.Footer.AppendChild(new Paragraph(new Run(new Drawing(new DW.Inline(shape)))));


        // Save changes
        document.MainDocumentPart.Document.Save();
    }
}

Remember to replace "filePath" with the actual path to your Word document. This code adds a simple rectangle. For more complex shapes or customizations, refer to the Open XML SDK documentation for details on available shape types and properties.

Handling Multiple Footers (Even/Odd Pages)

Word documents can have different footers for even and odd pages. The above code adds to the first footer part. To handle different footers, you'll need to identify the correct FooterPart based on page type. The MainDocumentPart.FooterParts collection provides access to all available footers. You can then examine the relationship ID to determine which footer applies to which pages.

Adding other Shapes

The example uses a rectangle. To add other shapes, modify the Preset attribute in the PresetGeometry element. Consult the Open XML documentation for a list of available presets. You can also manually define more complex shapes using Shape elements and their associated properties.

Error Handling and Robustness

Production-ready code should include comprehensive error handling. Consider adding try-catch blocks to handle potential exceptions, such as file not found or invalid file format. Also, always validate user input.

This detailed guide helps you add shapes to Word document footers using Open XML and C#. Remember to consult the official Open XML SDK documentation for advanced customization and a complete understanding of the API. By understanding the underlying XML structure and leveraging the powerful Open XML SDK, you can automate many Word document tasks.