Class ExcelBackgroundImage

An image that fills the background of the worksheet.

Inheritance

object

XmlHelper

ExcelBackgroundImage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OfficeOpenXml

Assembly: EPPlus.dll

Syntax

public class ExcelBackgroundImage : XmlHelper

Properties

Image

The background image of the worksheet. Note that images of type .svg, .ico and .webp is not supported as background images.

Declaration

public ExcelImage Image { get; }

Property Value

Type	Description
ExcelImage

Methods

Remove()

Removes the background image.

Declaration

public void Remove()

SetFromFile(FileInfo)

Set the picture from an image file.

Declaration

public void SetFromFile(FileInfo PictureFile)

Parameters

Type	Name	Description
FileInfo	PictureFile	The image file. Files of type .svg, .ico and .webp is not supported for background images

SetFromFile(string)

Set the picture from an image file.

Declaration

public void SetFromFile(string PictureFilePath)

Parameters

Type	Name	Description
string	PictureFilePath	The path to the image file. Files of type .svg, .ico and .webp is not supported for background images