Open Xml Word Processing How To Put Picture In Header

MIster jashon

6 min read

·

Oct 03, 2024

53

Share

Open XML Word Processing: How to Insert a Picture into the Header

In the world of document automation, Open XML offers a powerful and flexible approach to manipulate Word documents. Understanding how to insert a picture into the header of a Word document using Open XML can greatly enhance your automation capabilities. Let's delve into the specifics of this process.

Understanding Open XML Structure

Open XML represents a Word document as a collection of XML files organized in a specific structure. The core files include document.xml which defines the main content, and header1.xml, header2.xml, header3.xml and so on, which define the content of different headers.

The Code Breakdown

Let's look at a C# code example showcasing how to add a picture to a document's header using Open XML SDK:

using System;
using DocumentFormat.OpenXml;
using DocumentFormat.OpenXml.Packaging;
using DocumentFormat.OpenXml.Wordprocessing;
using A = DocumentFormat.OpenXml.Drawing;
using Pic = DocumentFormat.OpenXml.Drawing.Pictures;
using Drawing = DocumentFormat.OpenXml.Drawing;

public class InsertPictureHeader
{
    public static void Main(string[] args)
    {
        // Path to the Word document
        string documentPath = @"C:\MyDocument.docx";

        // Path to the image file
        string imagePath = @"C:\MyImage.jpg";

        // Open the document
        using (WordprocessingDocument wordDocument = WordprocessingDocument.Open(documentPath, true))
        {
            // Get the header part
            HeaderPart headerPart = wordDocument.MainDocumentPart.HeaderParts.FirstOrDefault(p => p.Header.HeaderReference.Type == HeaderValues.Default);

            // Create a new drawing element
            Drawing.Drawing drawing = new Drawing.Drawing() { Id = "rId1" };

            // Add the image to the drawing
            Pic.Picture picture = new Pic.Picture();
            Pic.NonVisualPictureProperties nonVisualPictureProperties = new Pic.NonVisualPictureProperties();
            Pic.NonVisualDrawingProperties nonVisualDrawingProperties = new Pic.NonVisualDrawingProperties() { Id = (UInt32Value)1, Name = "Picture 1" };
            Pic.NonVisualPictureDrawingProperties nonVisualPictureDrawingProperties = new Pic.NonVisualPictureDrawingProperties();

            // Add the image properties
            Pic.BlipFill blipFill = new Pic.BlipFill();
            Pic.Blip blip = new Pic.Blip() { Embed = "rId2" };
            blipFill.Append(blip);

            Pic.Stretch stretch = new Pic.Stretch();
            Pic.FillRectangle fillRectangle = new Pic.FillRectangle();
            stretch.Append(fillRectangle);
            blipFill.Append(stretch);

            // Add the image shape properties
            Pic.ShapeProperties shapeProperties = new Pic.ShapeProperties();
            A.Transform2D transform2D = new A.Transform2D();
            A.Offset offset = new A.Offset() { X = 0L, Y = 0L };
            A.Extents extents = new A.Extents() { Cx = 991800L, Cy = 748400L };
            transform2D.Append(offset);
            transform2D.Append(extents);
            shapeProperties.Append(transform2D);

            // Add all elements to the picture
            picture.Append(nonVisualPictureProperties);
            picture.Append(nonVisualDrawingProperties);
            picture.Append(nonVisualPictureDrawingProperties);
            picture.Append(blipFill);
            picture.Append(shapeProperties);
            drawing.Append(picture);

            // Add the drawing to the header
            headerPart.Header.Append(drawing);

            // Add the image to the document's relationships
            ImagePart imagePart = headerPart.AddImagePart(ImagePartType.Jpeg);
            using (System.IO.Stream stream = System.IO.File.OpenRead(imagePath))
            {
                imagePart.FeedData(stream);
            }
            AddImageRelationshipToHeader(headerPart, imagePart, "rId2");

            // Save the changes
            wordDocument.Save();
        }

        Console.WriteLine("Picture inserted successfully.");
    }

    // Helper method to add an image relationship to the header
    private static void AddImageRelationshipToHeader(HeaderPart headerPart, ImagePart imagePart, string relationshipId)
    {
        // Add the relationship to the header part
        headerPart.AddPart(imagePart, relationshipId);
    }
}

Explaining the Code:

1. Open the Word Document: The code opens the Word document using WordprocessingDocument.Open and sets the true flag to enable editing.
2. Get the Header Part: The code retrieves the header part using headerPart = wordDocument.MainDocumentPart.HeaderParts.FirstOrDefault(p => p.Header.HeaderReference.Type == HeaderValues.Default);. This assumes you are adding a picture to the default header.
3. Create the Drawing Element: A Drawing element is created to hold the image.
4. Add the Image: A Picture element is added to the Drawing element, followed by necessary elements for non-visual properties, blip fill, and shape properties.
5. Add Image Relationships: The code adds an image relationship to the header part using headerPart.AddPart(imagePart, relationshipId); to ensure the image is correctly referenced in the document.
6. Save the Changes: The code saves the modified Word document using wordDocument.Save();.

Essential Tips

• Image Size: Experiment with the image size and dimensions to achieve the desired appearance within the header.
• Image Format: Ensure the image format is supported by Open XML (e.g., JPEG, PNG, GIF).
• Header Type: Modify the code to target specific headers (e.g., header1, header2) if needed.
• Image Placement: Use the Offset element to fine-tune the image's position within the header.

Conclusion

Adding a picture to a Word document header using Open XML offers a streamlined approach to automating document formatting tasks. By understanding the code structure and applying the provided tips, you can effectively integrate pictures into your Word documents and enhance their visual appeal.