Class
ImageCollection

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:

cs-api-definition
public class ImageCollection : FilteredShapeCollection<FloatingImage>, IEnumerable<FloatingImage>, IEnumerable

Inheritance: objectFilteredShapeCollection<FloatingImage>ImageCollection

Implements: IEnumerableIEnumerable<FloatingImage>

Inherited Members FilteredShapeCollection<FloatingImage>.Remove(FloatingImage)FilteredShapeCollection<FloatingImage>.Contains(FloatingImage)FilteredShapeCollection<FloatingImage>.IndexOf(FloatingImage)FilteredShapeCollection<FloatingImage>.Clear()FilteredShapeCollection<FloatingImage>.GetEnumerator()FilteredShapeCollection<FloatingImage>.GetZIndex(FloatingImage)FilteredShapeCollection<FloatingImage>.Add(FloatingImage)FilteredShapeCollection<FloatingImage>.OnItemAdding(FloatingImage, out ShapeCollectionChangingEventArgs<FloatingImage>)FilteredShapeCollection<FloatingImage>.OnItemRemoving(FloatingImage, out ShapeCollectionChangingEventArgs<FloatingImage>)FilteredShapeCollection<FloatingImage>.OnChanging(ShapeCollectionChangingEventArgs<FloatingImage>)FilteredShapeCollection<FloatingImage>.OnChanged(ShapeCollectionChangedEventArgs<FloatingImage>)FilteredShapeCollection<FloatingImage>.CountFilteredShapeCollection<FloatingImage>.this[int]FilteredShapeCollection<FloatingImage>.WorksheetFilteredShapeCollection<FloatingImage>.ChangingFilteredShapeCollection<FloatingImage>.Changed

Constructors

ImageCollection(Worksheet)

Initializes a new image collection filtering the worksheet's shape collection to include only image-type shapes.

Declaration

cs-api-definition
public ImageCollection(Worksheet worksheet)

Parameters

worksheet

Worksheet

The worksheet.

Properties

ShapeType

Returns FloatingShapeType.Image, defining the filter criterion for this collection.

Declaration

cs-api-definition
public override FloatingShapeType ShapeType { get; }

Property Value

FloatingShapeType

Overrides FilteredShapeCollection<FloatingImage>.ShapeType

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

cs-api-definition
public FloatingImage Add(CellIndex cellIndex, double offsetX, double offsetY, ImageSource imageSource)

Parameters

cellIndex

CellIndex

The cell index where the top left corner of the shape is positioned.

offsetX

double

The left offset of the top left corner of the shape relative to the top left corner of the cell index.

offsetY

double

The top offset of the top left corner of the shape relative to the top left corner of the cell index.

imageSource

ImageSource

The image source.

Returns

FloatingImage

The result image shape.