How to Add Image to DOCX

Adding an Image

An image is referred programatically using its defined path in the local system. Firstly, instantiate the ImageContent class by providing the file path in string. Then, the image variable can be used all throughout the file in various locations or just to modify its properties, e.g. width, height. Finally, add the image to the .docx file using the AddImage() function. Once added, the document can be exported and saved locally. In the example below, we are adding the image inside the document without any parent node. The supported file formats are: .jpg, .png, .bmp, .tiff, .gif.

:path=/static-assets/word/content-code-examples/how-to/add-image-insert-image.cs

using IronWord;
using IronWord.Models;
using IronWord.Models.Enums;

// initializing docx file
WordDocument doc = new IronWord.WordDocument();

// instantiating image file
IronWord.Models.ImageContent image = new IronWord.Models.ImageContent("sample-image.jpg");

// modifying image properties
image.Width = 200;
image.Height = 200;

// AddImage function saving the image
doc.AddImage(image);

// Save and export the file
doc.SaveAs("inserted-image.docx");

IRON VB CONVERTER ERROR developers@ironsoftware.com

Adding Image via Stream

Images which are served locally or via a static URL are quite easy to directly add into a .docx file using the previous method. To add images which are behind a secure API, requiring authentication, the Stream method would be appropriate. In the example below, an HTTP client sends authorization tokens to the server, retrieves the authenticated image stream upon verification, and integrates it directly before exporting the final .docx file.

:path=/static-assets/word/content-code-examples/how-to/add-image-insert-image-via-http-stream.cs

using IronWord;
using IronWord.Models;
using IronWord.Models.Enums;

// initializing docx file
WordDocument doc = new IronWord.WordDocument();

using (HttpClient client = new HttpClient())
{
    // Add authentication headers
    client.DefaultRequestHeaders.Add("Authorization", "Bearer YOUR_API_KEY_HERE");
    client.DefaultRequestHeaders.Add("User-Agent", "MyApp/1.0");

    // Get image from authenticated endpoint
    Stream authenticatedStream = client.GetStreamAsync("https://api.example.com/secure/image.png");
    doc.AddImage(authenticatedStream);
}

// Export docx
doc.SaveAs("added-image-via-http-stream.docx");

IRON VB CONVERTER ERROR developers@ironsoftware.com

Modifying image properties

IronWord provides default customization methods for an image.

Customizing Width & Height

Custom width and height can be implemented altering predefined aspect ratio. An example is shown below.

:path=/static-assets/word/content-code-examples/how-to/add-image-custom-size.cs

using IronWord;
using IronWord.Models;
using IronWord.Models.Enums;

// initializing docx file
WordDocument doc = new IronWord.WordDocument();

// instantiating image file
IronWord.Models.ImageContent image = new IronWord.Models.ImageContent("sample-image.tiff");

// modifying the aspect ratio by introducing custom width
image.Width = 800;
image.Height = 200;

// AddImage function saving the image
doc.AddImage(image);

// Save and export the file
doc.SaveAs("custom-size-image.docx");

IRON VB CONVERTER ERROR developers@ironsoftware.com

$vbLabelText   $csharpLabel