Breaking Changes in EPPlus 6 (original) (raw)

Targeting frameworks

The EPPlus 6 Nuget package will no longer target .NET 4.0 and 4.5, as these versions are no longer supported.
EPPlus 6 will instead target .NET 4.5.2. A target for .NET 6 has also been added.

Removing dependency on System.Drawing.Common

In EPPlus 6 all public interfaces referencing to System.Drawing.Common has been removed. The reason for this is that Microsoft has deprecated System.Drawing.Common on all non-Windows platforms. To replace System.Drawing.Common we have implemented native code to handle the different image formats and text measurings. To handle Colors EPPlus adds a reference to System.Drawing.Primitives. This means that all references to Color will work as before.

The following methods and properties have been removed or changed:

The ExcelImage class

The ExcelImage class replaces all System.Drawing.Common.Image properties (see list above).

Properties Description
ImageBytes The image as a byte-array
Type The type of image, for example jpg, gif or svg
Bounds The bounds and resolution of the image
Methods Description
SetImage(string) Sets the image from a file path
SetImage(FileInfo) Sets the image from a FileInfo object
SetImage(byte[], ePictureType) Sets the image from a byte array
SetImage(Stream, ePictureType) Sets the image from a stream
SetImage(ExcelImage) Sets the image from another image object
SetImageAsync(string) Sets the image from a file path
SetImageAsync(FileInfo) Sets the image from a FileInfo object
SetImageAsync(Stream, ePictureType) Sets the image from a stream

All SetImage and SetImageAsync methods returns the ExcelImage object. This object can be used with SetImage(ExcelImage) overload.

Supported Image Formats.

The internal image handler supports the following image formats:

Adding extension methods for removed methods referencing System.Drawing.Common

Switching to overloads supported natively by EPPlus 6 is recommended, but if you have a lot of references to System.Drawing.Common, adding extension methods for images and fonts might simplify...

using System; using System.Drawing; using System.Drawing.Imaging; using System.IO; using OfficeOpenXml.Drawing; using OfficeOpenXml.Style; namespace OfficeOpenXml.Drawing.Extensions { public static class EPPlusDrawingExtensions { ///

/// Adds a picture to the drawings /// /// The collection /// The name of the drawing /// The image object to add /// A picture added to the drawings collection. public static ExcelPicture AddPicture(this ExcelDrawings drawings, string name, Image image) { var ms = new MemoryStream(); image.Save(ms, image.RawFormat); return drawings.AddPicture(name, ms, GetPictureType(image)); } /// /// Adds a picture to the drawings /// /// The collection /// The name of the drawing /// The image object to add /// An hyperlink reference used when clicking the drawing object. /// A picture added to the drawings collection. public static ExcelPicture AddPicture(this ExcelDrawings drawings, string name, Image image, Uri uri) { var ms = new MemoryStream(); image.Save(ms, image.RawFormat); return drawings.AddPicture(name, ms, GetPictureType(image), uri); } /// /// Sets the image /// /// The image object /// The image to set public static void SetImage(this ExcelImage xlImage, Image image) { var ms = new MemoryStream(); image.Save(ms, image.RawFormat); xlImage.SetImage(ms, GetPictureType(image)); } /// /// Sets the font from a font object /// /// The EPPlus Text Font object /// The font object. public static void SetFromFont(this ExcelTextFont xlFont, Font font) { xlFont.SetFromFont(font.Name, font.SizeInPoints, font.Bold, font.Italic, font.Underline, font.Strikeout); } /// /// Sets the font from a font object /// /// The EPPlus Text Font object /// The font object. public static void SetFromFont(this OfficeOpenXml.Style.ExcelFont xlFont, Font font) { xlFont.SetFromFont(font.Name, font.SizeInPoints, font.Bold, font.Italic, font.Underline, font.Strikeout); } private static ePictureType GetPictureType(Image image) { if (image.RawFormat.Equals(ImageFormat.Jpeg) || image.RawFormat.Equals(ImageFormat.Exif)) { return ePictureType.Jpg; } else if (image.RawFormat.Equals(ImageFormat.Gif)) { return ePictureType.Gif; } else if(image.RawFormat.Equals(ImageFormat.Png)) { return ePictureType.Png; } else if (image.RawFormat.Equals(ImageFormat.Emf)) { return ePictureType.Emf; } else if (image.RawFormat.Equals(ImageFormat.Wmf)) { return ePictureType.Wmf; } else if (image.RawFormat.Equals(ImageFormat.Tiff)) { return ePictureType.Tif; } else if (image.RawFormat.Equals(ImageFormat.Icon)) { return ePictureType.Ico; } else { return ePictureType.Bmp; } } } }

Remember to add the name space where you want to use the methods, so they are accessible.

using OfficeOpenXml.Drawing.Extensions;

Changed visibility of Formula calculation classes/interfaces.

One of our major focus areas for the continued development of EPPlus 6 is improving performance and functionality of the formula calculation. For this reason we have changed a number of classes, interfaces, methods and properties that in previous versions were public to internal as they are likely to go away or change drastically. This means that these items will no longer be accessible via the interfaces of EPPlus 6.

From public to internal

FontSize class

Static class 'FontSize' has splitted width and heights into two dictionaries. FontSizes are lazy-loaded when needed.

Removed methods

Also see Breaking Changes in EPPlus 5