System.ComponentModel.IContainer Interface

Summary

Provides functionality for containers. Containers are objects that logically contain zero or more components.

C# Syntax:

public interface IContainer : IDisposable

Containers are objects that encapsulate and track zero or more components. In this context, containment refers to logical containment, not visual containment. You can use components and containers in a variety of scenarios, including scenarios that are both visual and not visual.

Notes to implementors: To be a container, the class must implement the IContainer interface, which supports methods for adding, removing, and retrieving components.

	//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);
			}
		}
	}

    

System.ComponentModel Namespace | Component | IComponent | Container

System.ComponentModel.IContainer Member List:

Public Properties

Components

Read-only Gets all the components in the IContainer.

Public Methods

Add	Overloaded: Add(IComponent component) Adds the specified IComponent to the IContainer at the end of the list.
Add	Overloaded: Add(IComponent component, string name) Adds the specified IComponent to the IContainer at the end of the list, and assigns a name to the component.
Remove	Removes a component from the IContainer.

Hierarchy:

• System.IDisposable
• System.ComponentModel.IContainer

System.ComponentModel.IContainer Member Details

Summary

Gets all the components in the IContainer.

C# Syntax:

ComponentCollection Components {get;}

For a list of all members of this type, see .

Return to top

Summary

Adds the specified IComponent to the IContainer at the end of the list.

C# Syntax:

void Add(    IComponent component );

component

The IComponent to add.

The new IComponent is added at the end of the list.

Return to top

Summary

Adds the specified IComponent to the IContainer at the end of the list, and assigns a name to the component.

C# Syntax:

void Add(    IComponent component,    string name );

component

The IComponent to add.

name

The unique, case-insensitive name to assign to the component. -or-

null that leaves the component unnamed.

-or-

null that leaves the component unnamed.

The new IComponent is added at the end of the list.

Notes to inheritors: When you inherit from IContainer.Add, you must assure that name, if not null, is unique for this IContainer.

Return to top

Summary

Removes a component from the IContainer.

C# Syntax:

void Remove(    IComponent component );

component

The IComponent to remove.

Notes to inheritors: When you inherit from the IContainer.Remove method, you must also remove the ISite, if any, associated with this IComponent.

Return to top

Top of page