Class NamedObjects<T>

Provides a dictionary-based collection of named objects with change notification and item replacement events.

Inheritance
System.Object
NamedObjects<T>
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.Core
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class NamedObjects<T> : IEnumerable<T>, IEnumerable where T : INamedObject
Type Parameters
T

The type of the T.

Constructors

NamedObjects()

Initializes a new instance of the NamedObjects<T> class.

Declaration
public NamedObjects()

Properties

Count

Gets the total number of items in the collection.

Declaration
public int Count { get; }
Property Value
System.Int32

The count.

Item[Int32]

Gets the INamedObject at the specified index.

Declaration
public T this[int index] { get; }
Parameters
System.Int32 index

The index of the desired element.
Property Value
T

The item at specified index.

Methods

Add(T)

Adds the specified item.

Declaration
public void Add(T item)
Parameters
T item

The new item.

AddRange(IEnumerable<T>)

Adds multiple items to the collection in a single update scope, raising Changed once after all additions.

Declaration
public void AddRange(IEnumerable<T> items)
Parameters
System.Collections.Generic.IEnumerable<T> items

The range of items.

Clear()

Removes all items from the collection and raises the Changed event.

Declaration
public void Clear()

Contains(T)

Determines whether the specified item is contained in the collection.

Declaration
public bool Contains(T item)
Parameters
T item

The searched item.
Returns
System.Boolean

True if contained.

Contains(String)

Determines whether item with the specified name is contained in the collection.

Declaration
public bool Contains(string name)
Parameters
System.String name

The name of the searched item.
Returns
System.Boolean

True if contained.

GetByName(String)

Retrieves the item with the specified name, throwing an exception if not found.

Declaration
public T GetByName(string name)
Parameters
System.String name

The name of the searched item.
Returns
T

The searched item.

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()

OnChanged()

Called when the collection is changed.

Declaration
protected virtual void OnChanged()

OnItemReplaced(NamedObjectsItemReplaceEventArgs)

Raises the ItemReplaced event.

Declaration
protected virtual void OnItemReplaced(NamedObjectsItemReplaceEventArgs args)
Parameters
NamedObjectsItemReplaceEventArgs args

The NamedObjectsItemReplaceEventArgs instance containing the event data.

Remove(String)

Removes the item with the specified name from the collection and raises the Changed event.

Declaration
public void Remove(string name)
Parameters
System.String name

The name of the item.

Replace(String, T)

Replaces the item with the specified name with a new item, raising ItemReplaced and Changed events.

Declaration
public void Replace(string itemName, T item)
Parameters
System.String itemName

Name of the item to replace.
T item

The item to replace with.

TryGetByName(String, out T)

Attempts to retrieve the item with the specified name without throwing an exception if not found.

Declaration
public bool TryGetByName(string name, out T result)
Parameters
System.String name

The name of the searched item.
T result

The result.
Returns
System.Boolean

True if succeed.

Events

Changed

Raised after items are added, removed, or cleared, unless change events are suspended.

Declaration
public event EventHandler Changed
Event Type
System.EventHandler

ItemReplaced

Raised when an item is replaced via the Replace method, providing old and new item names.

Declaration
public event EventHandler<NamedObjectsItemReplaceEventArgs> ItemReplaced
Event Type
System.EventHandler<NamedObjectsItemReplaceEventArgs>

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()

Extension Methods