ClassFilteredShapeCollection<T>
Base collection for managing typed subsets of worksheet shapes, enabling filtered access and modification to shapes by type.
Definition
Namespace:Telerik.Windows.Documents.Spreadsheet.Model
Assembly:Telerik.Windows.Documents.Spreadsheet.dll
Type Parameters:
T
The type of the shape.
Syntax:
public abstract class FilteredShapeCollection<T> : IEnumerable<T>, IEnumerable where T : FloatingShapeBaseInheritance: objectFilteredShapeCollection<T>
Derived Classes:
Implements:
Properties
Count
Gets the number of shapes of type T in the collection.
ShapeType
Gets the shape type that this collection filters and manages.
Declaration
public abstract FloatingShapeType ShapeType { get; }Property Value
Worksheet
Gets the worksheet that owns this shape collection.
Declaration
protected Worksheet Worksheet { get; }Property Value
The worksheet.
Methods
Add(T)
Adds a shape to the collection and the underlying worksheet.
Declaration
public void Add(T item)Parameters
item
T
The item.
Clear()
Removes all shapes of type T from the collection.
Declaration
public void Clear()Contains(T)
Determines whether the collection contains the specified shape.
Declaration
public bool Contains(T item)Parameters
item
T
The note.
Returns
A value indicating whether the collection contains the specified shape.
GetEnumerator()
Returns an enumerator that iterates through the collection.
Declaration
public IEnumerator<T> GetEnumerator()Returns
IEnumerator<T>
A IEnumerator<T> that can be used to iterate through the collection.
Implements
GetZIndex(T)
Gets the layering order (ZIndex) of the specified shape, or -1 if not found.
Declaration
public int GetZIndex(T shape)Parameters
shape
T
Returns
The zero-based ZIndex. If the item is not found in the collection, -1 is returned.
IndexOf(T)
Searches for the specified shape and returns its zero-based index, or -1 if not found.
Declaration
public int IndexOf(T item)Parameters
item
T
The item.
Returns
The index of the item.
OnChanged(ShapeCollectionChangedEventArgs<T>)
Raises the event.
Declaration
protected virtual void OnChanged(ShapeCollectionChangedEventArgs<T> args)Parameters
args
ShapeCollectionChangedEventArgs<T>
The ShapeCollectionChangedEventArgs<T> instance containing the event data.
OnChanging(ShapeCollectionChangingEventArgs<T>)
Raises the event.
Declaration
protected virtual void OnChanging(ShapeCollectionChangingEventArgs<T> args)Parameters
args
ShapeCollectionChangingEventArgs<T>
The ShapeCollectionChangingEventArgs<T> instance containing the event data.
OnItemAdding(T, out ShapeCollectionChangingEventArgs<T>)
Invoked before adding a shape to the collection, enabling cancellation via the event args.
Declaration
protected void OnItemAdding(T shape, out ShapeCollectionChangingEventArgs<T> args)Parameters
shape
T
args
OnItemRemoving(T, out ShapeCollectionChangingEventArgs<T>)
Invoked before removing a shape from the collection, enabling cancellation via the event args.
Declaration
protected void OnItemRemoving(T shape, out ShapeCollectionChangingEventArgs<T> args)Parameters
shape
T
args
Events
Changed
Raised after a shape is added, removed, or the collection is cleared.
Declaration
public event EventHandler<ShapeCollectionChangedEventArgs<T>> ChangedEvent Value
Changing
Raised before a shape is added or removed, allowing the operation to be canceled.
Declaration
public event EventHandler<ShapeCollectionChangingEventArgs<T>> ChangingEvent Value