Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IComponent Interface

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Provides functionality required by all components.

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

[TypeConverterAttribute(typeof(ComponentConverter))]
[ComVisibleAttribute(true)]
public interface IComponent : IDisposable

NameDescription
System_CAPS_pubpropertySite

Gets or sets the ISite associated with the IComponent.

NameDescription
System_CAPS_pubmethodDispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.(Inherited from IDisposable.)

NameDescription
System_CAPS_pubeventDisposed

Represents the method that handles the Disposed event of a component.

Component is the default implementation of IComponent and serves as the base class for all components in the common language runtime.

You can contain components in a container. In this context, containment refers to logical containment, not visual containment. You can use components and containers in a variety of scenarios, both visual and non visual.

System.Windows.Forms.Control inherits from Component, the default implementation of IComponent.

A component interacts with its container primarily through a container-provided ISite, which is a repository of container-specific per-component information.

Notes to Implementers:

To be a component, a class must implement the IComponent interface and provide a basic constructor that requires no parameters or a single parameter of type IContainer. For more information about implementing IComponent, see Programming with Components.

The following code example demonstrates how to implement the IComponent, ISite, and IContainer interfaces.

/// <summary>
/// The following example demonstrates the implementation of 
/// ISite, IComponent, and IContainer for use in a simple library container.
///
/// This example uses the System, System.ComponentModel, and System.Collections
/// namespaces.
/// </summary>

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

//Implement the ISite interface.

// The ISBNSite class represents the ISBN name of the book component
class ISBNSite : ISite
{
	private IComponent m_curComponent;
	private IContainer m_curContainer;
	private bool m_bDesignMode;
	private string m_ISBNCmpName;

	public ISBNSite(IContainer actvCntr, IComponent prntCmpnt)
	{
		m_curComponent = prntCmpnt;
		m_curContainer = actvCntr;
		m_bDesignMode = false;
		m_ISBNCmpName = null;
	}

	//Support the ISite interface.
	public virtual IComponent Component
	{
		get
		{
			return m_curComponent;
		}
	}

	public virtual IContainer Container
	{
		get
		{
			return m_curContainer;
		}
	}

	public virtual bool DesignMode
	{
		get
		{
			return m_bDesignMode;
		}
	}

	public virtual string Name
	{
		get
		{
			return m_ISBNCmpName;
		}

		set
		{
			m_ISBNCmpName = value;
		}
	}

	//Support the IServiceProvider interface.
	public virtual object GetService(Type serviceType)
	{
		//This example does not use any service object.
		return null;
	}

}

// The BookComponent class represents the book component of the library container.

// This class implements the IComponent interface.

class BookComponent : IComponent
{
	public event EventHandler Disposed;
	private ISite m_curISBNSite;
	private string m_bookTitle;
	private string m_bookAuthor;

	public BookComponent(string Title, string Author)
	{
		m_curISBNSite = null;
		Disposed = null;
		m_bookTitle = Title;
		m_bookAuthor = Author;
	}

	public string Title
	{
		get
		{
			return m_bookTitle;
		}
	}

	public string Author
	{
		get
		{
			return m_bookAuthor;
		}
	}

	public virtual void Dispose()
	{	
		//There is nothing to clean.
		if(Disposed != null)
			Disposed(this,EventArgs.Empty);
	}

	public virtual ISite Site
	{
		get
		{
			return m_curISBNSite;
		}
		set
		{
			m_curISBNSite = value;
		}
	}

	public override bool Equals(object cmp)
	{
		BookComponent cmpObj = (BookComponent)cmp;
		if(this.Title.Equals(cmpObj.Title) && this.Author.Equals(cmpObj.Author))
			return true;

		return false;
	}

	public override int GetHashCode()
	{
		return base.GetHashCode();
	}
}

.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show:
© 2018 Microsoft