IEmbeddedObjects Interface
Use this interface to read or write Embedded drawing objects inside other object.
Syntax
Namespace: FlexCel.Core
public interface IEmbeddedObjects;
Methods
Name | Description |
---|---|
GetObjectProperties | Returns information on an object and all of its children. |
SetObjectText | Overloaded SetObjectText(Int32, String, String) SetObjectText(Int32, String, TRichString) SetObjectText(Int32, String, TDrawingRichString) |
DeleteObject | Overloaded DeleteObject(Int32) DeleteObject(Int32, String) |
GetImage | Returns an image and its type. Note that for SVG images, xlsx files store both a PNG and SVG image. In those cases, for backward compatibility reasons, this method will return the PNG image. To get the SVG, call GetImageAlternate |
HasImageAlternate | Returns true if the image has an alternate representation. This currently happens only with SVG images, which have a PNG base and an SVG alternate. If the image has an alternate, you can get the data with GetImageAlternate |
GetImageAlternate | Returns an image and its type. Currently this method is the same as GetImage for all images except SVG. For SVG images, xlsx files store both a PNG and SVG image. In those cases, this method will return the SVG image. To get the PNG, call GetImage |
AddImageAlternate | Adds an image to the active sheet. Currently this method is only needed for SVG images, since SVG images are stored as both PNG and SVG inside the xlsx file. This method allows you to supply both images. |
GetImageProperties | Returns image position and size. |
DeleteImage | Deletes the image at position imageIndex. |
GetShapeLinkedCell | Returns the cell that is linked to the shape or image. If the object isn't linked, this method will return null. Note that when you change the value in the cell linked to this object, the value of the object will change. Also note that this method applies to shapes like a rectangle or circle, or an image. Objects like a combobox won't be reported by this method. |
SetShapeLinkedCell | Links the shape or image to a cell, if the shape can be linked. To unlink the cell, make linkedCell null. Note that this method applies to shapes like a rectangle or a circle, or an image, not to the link of a forms object like a combobox or a radiobutton. |
ImageIndexToObjectPath | Returns the absolute object path for an image, given an image index. Note that this method can be slow if there are many objects in the file. Whenever possible, prefer the methods that take directly an imageIndex instead of converting the imageIndex to an objectPath. |
Properties
Name | Description |
---|---|
ObjectCount | The number of objects that are embedded inside this object. |
ImageCount | The number of images in the object. |