SaveImageEventArgs Class

Arguments passed on FlexCelHtmlExport.OnSaveImage,

Syntax

Namespace: FlexCel.Render

public class SaveImageEventArgs: EventArgs

Constructors

Name	Description
SaveImageEventArgs	Creates a new Argument.

Properties

Name	Description
AlternateText	Alternate text for the image, to show in the "ALT" tag when a browser cannot display images. By default this is set to the text in the box "Alternative Text" in the web tab on the image properties. If no Alternative text is supplied in the file, the image name will be used here.
ImageFile	The file where the image is expected to be saved.
ImageLink	The link that will be inserted in the html file.
ImageToSave	Image that will be saved. You can use it to save it yourself. Note that when saving as SVG, this will be null.
ObjectIndex	Object index of the object being rendered. You can use xls.​Get​Object(​object​Index) to get the object properties. If the image is not an object (for example it is a rotated text) this property will be -1.
Processed	Set this property to true if you have taken care of saving the image, and FlexCel does not need to save it. If you just used this event to get information on the image being saved, but would like to keep the normal flux, set it to false.
SavedImageFormat	File format in which the image is.
ShapeProps	Shape properties of the object being rendered. You can use them to get the name of the object, its size, etc. If the image is not an object (for example it is a rotated text) this property will be null.
Workbook	ExcelFile with the image, positioned in the sheet that we are rendering. Make sure if you modify ActiveSheet of this instance to restore it back to the original value before exiting the event.