ComponentCollection Class
TOC
Collapse the table of content
Expand the table of content

ComponentCollection Class

 

Provides a read-only container for a collection of IComponent objects.

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)

System.Object
  System.Collections.ReadOnlyCollectionBase
    System.ComponentModel.ComponentCollection

[ComVisibleAttribute(true)]
[HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization = true)]
public class ComponentCollection : ReadOnlyCollectionBase

NameDescription
System_CAPS_pubmethodComponentCollection(IComponent[])

Initializes a new instance of the ComponentCollection class using the specified array of components.

NameDescription
System_CAPS_pubpropertyCount

Gets the number of elements contained in the ReadOnlyCollectionBase instance.(Inherited from ReadOnlyCollectionBase.)

System_CAPS_protpropertyInnerList

Gets the list of elements contained in the ReadOnlyCollectionBase instance.(Inherited from ReadOnlyCollectionBase.)

System_CAPS_pubpropertyItem[Int32]

Gets the Component in the collection at the specified collection index.

System_CAPS_pubpropertyItem[String]

Gets any component in the collection matching the specified name.

NameDescription
System_CAPS_pubmethodCopyTo(IComponent[], Int32)

Copies the entire collection to an array, starting writing at the specified array index.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetEnumerator()

Returns an enumerator that iterates through the ReadOnlyCollectionBase instance.(Inherited from ReadOnlyCollectionBase.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection.CopyTo(Array, Int32)

Copies the entire ReadOnlyCollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array.(Inherited from ReadOnlyCollectionBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.IsSynchronized

Gets a value indicating whether access to a ReadOnlyCollectionBase object is synchronized (thread safe).(Inherited from ReadOnlyCollectionBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.SyncRoot

Gets an object that can be used to synchronize access to a ReadOnlyCollectionBase object.(Inherited from ReadOnlyCollectionBase.)

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

This collection inherits from ReadOnlyCollectionBase. The only way to add IComponent objects to this collection is to use the class constructor.

This collection provides two indexer properties, a string indexer and an integer indexer. The string indexer property returns a component in the collection by name if the Site property of a component in the collection is not null and the Name property of the Site property of the component matches the specified string. The integer indexer property returns the IComponent at the specified collection index. The CopyTo method copies the contents of the collection to a specified array, beginning writing to the array at the specified index.

The following code example demonstrates how to use a ComponentCollection to enumerate a collection of custom BookComponent objects.

//This code segment implements the IContainer interface.  The code segment 
//containing the implementation of ISite and IComponent can be found in the documentation
//for those interfaces.

//Implement the LibraryContainer using the IContainer interface.

class LibraryContainer : IContainer
{
	private ArrayList m_bookList;

	public LibraryContainer()
	{
		m_bookList = new ArrayList();
	}

	public virtual void Add(IComponent book)
	{
		//The book will be added without creation of the ISite object.
		m_bookList.Add(book);
	}

	public virtual void Add(IComponent book, string ISNDNNum)
	{
		for(int i =0; i < m_bookList.Count; ++i)
		{
			IComponent curObj = (IComponent)m_bookList[i];
			if(curObj.Site != null)
			{
				if(curObj.Site.Name.Equals(ISNDNNum))
					throw new SystemException("The ISBN number already exists in the container"); 
			}
		}

		ISBNSite data = new ISBNSite(this, book);
		data.Name = ISNDNNum;
		book.Site = data;
		m_bookList.Add(book);
	}

	public virtual void Remove(IComponent book)
	{
		for(int i =0; i < m_bookList.Count; ++i)
		{				
			if(book.Equals(m_bookList[i]))
			{
				m_bookList.RemoveAt(i);
					break;
			}
		}
	}

	public ComponentCollection Components
	{
		get
		{
			IComponent[] datalist = new BookComponent[m_bookList.Count];
			m_bookList.CopyTo(datalist);
			return new ComponentCollection(datalist);
		}
	}

	public virtual void Dispose()
	{	
		for(int i =0; i < m_bookList.Count; ++i)
		{
			IComponent curObj = (IComponent)m_bookList[i];
			curObj.Dispose();
		}

		m_bookList.Clear();
	}

	static void Main(string[] args)
	{
		LibraryContainer cntrExmpl = new LibraryContainer();

		try
		{
			BookComponent book1 = new BookComponent("Wizard's First Rule", "Terry Gooodkind");
			cntrExmpl.Add(book1, "0812548051");
			BookComponent book2 = new BookComponent("Stone of Tears", "Terry Gooodkind");
			cntrExmpl.Add(book2, "0812548094");
			BookComponent book3 = new BookComponent("Blood of the Fold", "Terry Gooodkind");
			cntrExmpl.Add(book3, "0812551478");
			BookComponent book4 = new BookComponent("The Soul of the Fire", "Terry Gooodkind");
			//This will generate exception because the ISBN already exists in the container.
			cntrExmpl.Add(book4, "0812551478");
		}
		catch(SystemException e)
		{
			Console.WriteLine("Error description: " + e.Message);
		}

		ComponentCollection datalist =cntrExmpl.Components;
		IEnumerator denum = datalist.GetEnumerator();

		while(denum.MoveNext())
		{
			BookComponent cmp = (BookComponent)denum.Current;
			Console.WriteLine("Book Title: " + cmp.Title);
			Console.WriteLine("Book Author: " + cmp.Author);
			Console.WriteLine("Book ISBN: " + cmp.Site.Name);
		}
	}
}

Universal Windows Platform
Available since 10
.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft