Class FilteredShapeCollection<T>

Represents a base for classes representing collections of a specific type of shapes.

Inheritance

System.Object

FilteredShapeCollection<T>

ChartCollection

CommentCollection

ImageCollection

NoteCollection

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Telerik.Windows.Documents.Spreadsheet.Model

Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public abstract class FilteredShapeCollection<T> : IEnumerable<T>, IEnumerable where T : FloatingShapeBase

Type Parameters

T The type of the shape.

Properties

Count

Gets the item count.

Declaration

public int Count { get; }

Property Value

System.Int32 The item count.

Item[Int32]

Gets the shape at the specified index.

Declaration

public T this[int index] { get; }

Parameters

System.Int32 index

Property Value

T

ShapeType

Gets the type of the shape.

Declaration

public abstract FloatingShapeType ShapeType { get; }

Property Value

FloatingShapeType

Worksheet

Gets the worksheet.

Declaration

protected Worksheet Worksheet { get; }

Property Value

Worksheet The worksheet.

Methods

Add(T)

Adds a new item to the collection.

Declaration

public void Add(T item)

Parameters

T item The item.

Clear()

Clears this instance.

Declaration

public void Clear()

Contains(T)

Determines whether the collection contains the specified shape.

Declaration

public bool Contains(T item)

Parameters

T item The note.

Returns

System.Boolean 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

System.Collections.Generic.IEnumerator<T> A System.Collections.Generic.IEnumerator<T> that can be used to iterate through the collection.

Implements

System.Collections.Generic.IEnumerable<T>.GetEnumerator()

GetZIndex(T)

Gets the ZIndex of the specified shape.

Declaration

public int GetZIndex(T shape)

Parameters

T shape

Returns

System.Int32 The zero-based ZIndex. If the item is not found in the collection, -1 is returned.

IndexOf(T)

Searches for the specified item and returns the zero-based index of the first occurrence within the entire collection.

Declaration

public int IndexOf(T item)

Parameters

T item The item.

Returns

System.Int32 The index of the item.

OnChanged(ShapeCollectionChangedEventArgs<T>)

Raises the Changed event.

Declaration

protected virtual void OnChanged(ShapeCollectionChangedEventArgs<T> args)

Parameters

ShapeCollectionChangedEventArgs<T> args The ShapeCollectionChangedEventArgs<T> instance containing the event data.

OnChanging(ShapeCollectionChangingEventArgs<T>)

Raises the Changing event.

Declaration

protected virtual void OnChanging(ShapeCollectionChangingEventArgs<T> args)

Parameters

ShapeCollectionChangingEventArgs<T> args The ShapeCollectionChangingEventArgs<T> instance containing the event data.

OnItemAdding(T, out ShapeCollectionChangingEventArgs<T>)

Called when an item is going to be added to the collection.

Declaration

protected void OnItemAdding(T shape, out ShapeCollectionChangingEventArgs<T> args)

Parameters

T shape

ShapeCollectionChangingEventArgs<T> args

OnItemRemoving(T, out ShapeCollectionChangingEventArgs<T>)

Called when an item from the collections is going to be removed.

Declaration

protected void OnItemRemoving(T shape, out ShapeCollectionChangingEventArgs<T> args)

Parameters

T shape

ShapeCollectionChangingEventArgs<T> args

Remove(T)

Removes the specified item from the collection.

Declaration

public virtual bool Remove(T item)

Parameters

T item The item.

Returns

System.Boolean The value indicating whether the specified shape was found.

Events

Changed

Occurs when the collection has changed.

Declaration

public event EventHandler<ShapeCollectionChangedEventArgs<T>> Changed

Event Type

System.EventHandler<ShapeCollectionChangedEventArgs<T>>

Changing

Occurs when the collection is changing.

Declaration

public event EventHandler<ShapeCollectionChangingEventArgs<T>> Changing

Event Type

System.EventHandler<ShapeCollectionChangingEventArgs<T>>

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

System.Collections.IEnumerator An System.Collections.IEnumerator object that can be used to iterate through the collection.

Implements

System.Collections.IEnumerable.GetEnumerator()