ClassImageCollection
Filtered collection of floating images within a worksheet, providing typed access and creation methods for image shapes.
Definition
Namespace:Telerik.Windows.Documents.Spreadsheet.Model
Assembly:Telerik.Windows.Documents.Spreadsheet.dll
Syntax:
public class ImageCollection : FilteredShapeCollection<FloatingImage>, IEnumerable<FloatingImage>, IEnumerable
Inheritance: objectFilteredShapeCollection<FloatingImage>ImageCollection
Implements:
Inherited Members
Constructors
ImageCollection(Worksheet)
Initializes a new image collection filtering the worksheet's shape collection to include only image-type shapes.
Declaration
public ImageCollection(Worksheet worksheet)
Parameters
worksheet
The worksheet.
Properties
ShapeType
Returns FloatingShapeType.Image, defining the filter criterion for this collection.
Declaration
public override FloatingShapeType ShapeType { get; }
Property Value
Overrides
Methods
Add(CellIndex, double, double, ImageSource)
Creates a new floating image anchored at the specified cell and offset with the provided image source, adds it to the worksheet, and returns the image shape.
Declaration
public FloatingImage Add(CellIndex cellIndex, double offsetX, double offsetY, ImageSource imageSource)
Parameters
cellIndex
The cell index where the top left corner of the shape is positioned.
offsetX
The left offset of the top left corner of the shape relative to the top left corner of the cell index.
offsetY
The top offset of the top left corner of the shape relative to the top left corner of the cell index.
imageSource
The image source.
Returns
The result image shape.