Skip to content

Class ExcelBackgroundImage

Namespace: OfficeOpenXml
Assembly: EPPlus.dll

An image that fills the background of the worksheet.

public class ExcelBackgroundImage : XmlHelper

Inheritance

object ← XmlHelper ← ExcelBackgroundImage

Inherited Members

object.Equals(object?, object?)
object.Equals(object?)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object?, object?)
object.ToString()

Properties

Image

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

public ExcelImage Image { get; }

Property Value

ExcelImage

Methods

Remove()

Removes the background image.

public void Remove()

SetFromFile(FileInfo)

Set the picture from an image file.

public void SetFromFile(FileInfo PictureFile)

Parameters

PictureFile FileInfo

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.

public void SetFromFile(string PictureFilePath)

Parameters

PictureFilePath string

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