Table of Contents

XlsFile.SetImage Method

Sets the image data and / or image properties of an existing image. Note that for SVG images, xlsx files store both a PNG and SVG image. To enter an SVG image, use ExcelFile.SetImageAlternate

Syntax

Namespace: FlexCel.XlsAdapter

public override void SetImage(Int32 imageIndex, Byte[] data, TXlsImgType imageType, Boolean usesObjectIndex, String objectPath)

Parameters

<-> Parameter Type Description
imageIndex Int32 Index of the image on the sheet array (1-based)
data Byte[] Image data.
imageType TXlsImgType Image type of the new data.
usesObjectIndex Boolean If false (the default) then imageIndex is an index to the list of images.
When true imageIndex is an index to the list of all objects in the sheet. When you have the object id, you can avoid calling ExcelFile.ObjectIndexToImageIndex which is a slow method, by setting this parameter to true.
objectPath String Path to the object, when the object is grouped with others. This parameter only has meaning if usesObjectIndex is true.

If it is "absolute"(it starts with "\"), then the path includes the objectIndex, and the objectIndex is not used. An object path of "\1\2\3" is exactly the same as using objectIndex = 1 and objectPath = "2\3"

See also