open xml how to add shape to footer in word

Daniel Parker

4 min read

·

01-03-2025

1

0

Share

Adding shapes to Word document footers programmatically offers significant advantages for automating document creation and customization. This article demonstrates how to achieve this using Open XML, providing a detailed walkthrough and code examples in C#. This technique is invaluable for generating reports, templates, or any document requiring consistent footer branding.

Understanding the Open XML Structure

Open XML is the standard format for Word documents (.docx). It uses XML to store document content, including text, images, and shapes. To add a shape to a footer, we'll manipulate the XML structure directly. This requires understanding the relevant XML elements within the footer part of the document.

Prerequisites

Before we begin, make sure you have the following:

• Open XML SDK: Install the Open XML SDK 2.5 from NuGet Package Manager. This provides the necessary classes and methods for working with Open XML files.
• C# Development Environment: Visual Studio or a similar IDE is recommended.

Step-by-Step Guide: Adding a Shape to the Footer

This guide uses C# to illustrate the process. Adaptations to other languages using Open XML SDK should be relatively straightforward.

1. Load the Word Document:

First, load your existing Word document using the Document class from the Open XML SDK. If creating a new document, instantiate a new WordprocessingDocument object.

using DocumentFormat.OpenXml.Packaging;
using DocumentFormat.OpenXml.Wordprocessing;

// Load existing document
using (WordprocessingDocument document = WordprocessingDocument.Open("YourDocument.docx", true)) 
{
    // ... Add shape code here ...
}

// Create new document
using (WordprocessingDocument document = WordprocessingDocument.Create("NewDocument.docx", WordprocessingDocumentType.Document))
{
    // ... Add shape code here ...  (requires creating main document part first)
}

Replace "YourDocument.docx" with the path to your document. The true argument allows for modification.

2. Access the Footer Part:

Next, locate the footer part of the document. This part contains the content for the footer. Footers can be section-specific, so you might need to iterate through sections to find the correct footer.

// Find the main document part
MainDocumentPart mainPart = document.MainDocumentPart;

// Get the sections (assuming there's at least one section with a footer)
IEnumerable<SectionProperties> sections = mainPart.Document.Body.Descendants<SectionProperties>();

foreach (SectionProperties sectionProps in sections)
{
    // Get the footer reference
    FooterReference footerRef = sectionProps.Descendants<FooterReference>().FirstOrDefault();

    if (footerRef != null)
    {
        // Get the footer part
        FooterPart footerPart = (FooterPart)mainPart.GetPartById(footerRef.Id);

        // Now work with the footerPart
        // ... Add shape code below ...
    }
}

3. Add the Shape:

This is where we insert the shape. We'll use a simple rectangle as an example. You can explore other shape types available in the Open XML SDK.

// Add a drawing element to the footer
Drawing drawing = new Drawing();
footerPart.Footer.Append(drawing);

// Add a graphic data element
GraphicData graphicData = new GraphicData { Uri = "http://schemas.openxmlformats.org/drawingml/2006/picture" };
drawing.Append(graphicData);

// Add a shape element (Rectangle example)
Inline inline = new Inline();
Shape shape = new Shape(); // You'll need to set properties here (see below)
inline.Append(shape);
graphicData.Append(inline);

4. Configure Shape Properties:

The shape element needs properties to define its appearance (size, color, etc.). This requires understanding the DrawingML schema, which defines how shapes are represented in Open XML. This is more complex and often involves creating a BlipFill (for image fills) or setting SolidFill properties for solid color fills. Refer to the Open XML SDK documentation for detailed options. A simplified example focusing on size and position might look like:

// Example: Setting shape size and position (requires more complex setup for color etc.)
shape.Append(new blipFill()); // fill options to be added here
shape.Append(new stretch()); // fill options to be added here
shape.Append(new Transform2D()); // transform options to be added here
shape.Append(new NonVisualShapeProperties()); // Non visual shape properties
shape.Append(new ShapeProperties() { BlackWhiteMode = BlackWhiteModeValues.Auto }); //Shape properties

5. Save the Document:

Finally, save the changes to the document.

document.Save();

Complete Example (Simplified):

This provides a simplified example. Remember to explore the Open XML SDK documentation for more advanced shape customization.

using DocumentFormat.OpenXml.Packaging;
using DocumentFormat.OpenXml.Wordprocessing;
using DocumentFormat.OpenXml.Drawing;
using DocumentFormat.OpenXml.Drawing.Wordprocessing;

// ... (Load document as shown in Step 1) ...

// ... (Access Footer Part as shown in Step 2) ...

// Add a rectangle shape (simplified – needs extensive customization for real-world use)
Drawing drawing = new Drawing();
footerPart.Footer.Append(drawing);
GraphicData graphicData = new GraphicData { Uri = "http://schemas.openxmlformats.org/drawingml/2006/picture" };
drawing.Append(graphicData);
Inline inline = new Inline();
Shape shape = new Shape();
// You MUST add shape properties here - see extensive documentation on Open XML for details
inline.Append(shape);
graphicData.Append(inline);

// ... (Save document as shown in Step 5) ...

This provides a fundamental understanding of adding shapes to Word document footers using Open XML. Remember that comprehensive shape customization requires a deeper dive into the DrawingML schema within the Open XML SDK documentation. Thorough error handling and input validation should be included in a production-ready application.