Pictures

EPPlus supports adding/modifying/removing pictures on worksheets. Pictures are accessed via ExcelWorksheet's Drawings property and you can add them via a file path, a FileInfo instance or a Stream. You can also add a hyperlink to a picture by supplying an Uri or an ExcelHyperlink to the AddPicture method.

The AddPicture method¶

Pictures are added to worksheets via the AddPicture method, which is accessed via the Drawings property on ExcelWorksheet. This method has many overloads and returns an ExcelPicture instance. Via the properties of ExcelPicture you can set properties like size, border, fill and other effects.

The ExcelPicture class also has an Image property that represents the actual image. See the ExcelImage class below.

There are async versions of AddPicture, these are named AddPictureAsync.

Example¶

Adding a picture/image to the workbook will work in a very similar way as adding a Shape

//Add a jpg image and apply some effects (EPPlus 6+ interface).
var pic = worksheet.Drawings.AddPicture("Landscape", new FileInfo("c:\\temp\\LandscapeView.jpg"));
pic.SetPosition(2, 0, 1, 0);
pic.Effect.SetPresetShadow(ePresetExcelShadowType.OuterBottomRight);
pic.Effect.OuterShadow.Distance = 10;
pic.Effect.SetPresetSoftEdges(ePresetExcelSoftEdgesType.SoftEdge5Pt);

'Add a jpg image and apply some effects (EPPlus 6+ interface).
Dim pic = worksheet.Drawings.AddPicture("Landscape", New FileInfo("c:\temp\LandscapeView.jpg"))
pic.SetPosition(2, 0, 1, 0)
pic.Effect.SetPresetShadow(ePresetExcelShadowType.OuterBottomRight)
pic.Effect.OuterShadow.Distance = 10
pic.Effect.SetPresetSoftEdges(ePresetExcelSoftEdgesType.SoftEdge5Pt)

Read existing pictures¶

var pics = worksheet.Drawings.Where(x => x.DrawingType == eDrawingType.Picture).Select(x => x.As.Picture);
foreach(var pic in pics)
{
    var name = pic.Name;
    var imageType = pic.Image.Type;
    var width = pic.Image.Bounds.Width;
    // etc
}

Dim pics = worksheet.Drawings.Where(Function(x) x.DrawingType = eDrawingType.Picture).Select(Function(x) x.As.Picture)
For Each pic In pics
    Dim name = pic.Name
    Dim imageType = pic.Image.Type
    Dim width = pic.Image.Bounds.Width
    ' etc
Next

Re-arrange vertically¶

As with any other Drawing you can use the SendToBack and BringToFront methods to adjust how a Picture is located vertically compared with other Drawings.

pic.BringToFront();
// or
pic.SendToBack();

pic.BringToFront()
' or
pic.SendToBack()

Remove a Picture¶

You can remove a shape from a worksheet via the Drawings.Remove method.

// remove by instance
var itemToRemove = worksheet.Drawings.FirstOrDefault(x => x.Name == "myPic");
if(itemToRemove != null)
{
    worksheet.Drawings.Remove(itemToRemove);
}

// remove by index
worksheet.Drawings.Remove(0);

// remove by name
worksheet.Drawings.Remove("myPic");

' remove by instance
Dim itemToRemove = worksheet.Drawings.FirstOrDefault(Function(x) x.Name = "myPic")
If itemToRemove IsNot Nothing Then
    worksheet.Drawings.Remove(itemToRemove)
End If

' remove by index
worksheet.Drawings.Remove(0)

' remove by name
worksheet.Drawings.Remove("myPic")

The ExcelImage class¶

From EPPlus 6, the ExcelImage class replaces all System.Drawing.Common.Image properties (see list above).

Constructors¶

Methods¶