TImageInformationEventArgs Class
Arguments passed on TFlexCelHtmlExport.OnGetImageInformation,
Syntax
Unit: FlexCel.Render
TImageInformationEventArgs = class(EventArgs);Constructors
| Name | Description |
|---|---|
| Create | Creates a new Argument. |
Properties
| Name | Description |
|---|---|
| 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. |
| ObjectIndex | Object index of the object being rendered. You can use xls.GetObject(objectIndex) to get the object properties, or you can use this property to attach an unique number in the sheet to the image filename. If the image is not an object (for example it is a rotated text) this property will be -1. |
| 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. |
| ImageStream | The stream where the images will be saved. Keep it null to store the image as a file using ImageFile. When saving as MHTML this parameter does nothing, since all images will be saved in the same MTHML stream. |
| ImageFile | The file where the image will be saved. If ImageStream is not null, this property will do nothing. If both this property and ImageStream are null, the image will not be saved. When saving as MHTML this parameter does nothing, since all images will be saved in the same MTHML stream. |
| ImageLink | The link that will be inserted in the html file. Change it if you change the default image location. Set it to null to not add a link to this image in the generated html file. If you want to avoid exporting all images, you can use THidePrintObjects for that. But if you just want to avoid exporting one image in a file, you can do it by setting ImageStream, ImageFile and this property to null. |
| ImageLinkNeedsEscaping | If true (the default) the link you provide in ImageLink is not escaped and will be escaped by FlexCel. So for example, the link "http://my site" will be escaped to "http://my%%20site". If the link you provided was already escaped, then set this variable to false. |
| 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. |
| HyperLink | Hyperlink where the image will point to. This is automatically read from the image hyperlink if it has one, but you can modify, delete or add a new hyperlink for any image with this property. |
| HyperLinkTitle | Hyperlink title if the image has an hyperlink. |
| SavedImageFormat | File format in which to save this image. Do not modify it to keep the default format. Important: If you want to render the charts as SVG objects instead of PNG bitmaps, you need to set this property to THtmlImageFormat.Svg. |