Export (0) Print
Expand All

IContainer Interface

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

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

[ComVisibleAttribute(true)] 
public interface IContainer : IDisposable
/** @attribute ComVisibleAttribute(true) */ 
public interface IContainer extends IDisposable
ComVisibleAttribute(true) 
public interface IContainer extends IDisposable
Not applicable.

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 Implementers: To be a container, the class must implement the IContainer interface, which supports methods for adding, removing, and retrieving components.

The following code example demonstrates how to implement the IContainer interface.

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

// 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 implements IContainer
{
    private ArrayList mBookList;

    public LibraryContainer()
    {
        mBookList = new ArrayList();
    } //LibraryContainer

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

    public void Add(IComponent book, String isndNNum) throws SystemException
    {
        for (int i = 0; i < mBookList.get_Count(); ++i) {
            IComponent curObj = (IComponent)mBookList.get_Item(i);
            if (curObj.get_Site() != null) {
                if (curObj.get_Site().get_Name().Equals(isndNNum)) {
                    throw new SystemException(
                        "The ISBN number already exists in the container");
                }
            }
        }
        ISBNSite data = new ISBNSite(this, book);
        data.set_Name(isndNNum);
        book.set_Site(data);
        mBookList.Add(book);
    } //Add

    public void Remove(IComponent book)
    {
        for (int i = 0; i < mBookList.get_Count(); ++i) {
            if (book.Equals(mBookList.get_Item(i))) {
                mBookList.RemoveAt(i);
                break;
            }
        }
    } //Remove

    /** @property 
     */
    public ComponentCollection get_Components()
    {
        IComponent dataList[] = new BookComponent[mBookList.get_Count()];
        mBookList.CopyTo(dataList);
        return new ComponentCollection(dataList);
    } //get_Components

    public void Dispose()
    {
        for (int i = 0; i < mBookList.get_Count(); ++i) {
            IComponent curObj = (IComponent)mBookList.get_Item(i);
            curObj.Dispose();
        }
        mBookList.Clear();
    } //Dispose

    public 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.get_Message());
        }
        ComponentCollection dataList = cntrExmpl.get_Components();
        IEnumerator denum = dataList.GetEnumerator();

        while (denum.MoveNext()) {
            BookComponent cmp = (BookComponent)denum.get_Current();
            Console.WriteLine("Book Title: " + cmp.get_Title());
            Console.WriteLine("Book Author: " + cmp.get_Author());
            Console.WriteLine("Book ISBN: " + cmp.get_Site().get_Name());
        }
    } //main
} //LibraryContainer

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft