IComponent Interface
Assembly: System (in system.dll)
'Declaration <TypeConverterAttribute(GetType(ComponentConverter))> _ <ComVisibleAttribute(True)> _ Public Interface IComponent Inherits IDisposable 'Usage Dim instance As IComponent
/** @attribute TypeConverterAttribute(System.ComponentModel.ComponentConverter) */ /** @attribute ComVisibleAttribute(true) */ public interface IComponent extends IDisposable
TypeConverterAttribute(System.ComponentModel.ComponentConverter) ComVisibleAttribute(true) public interface IComponent extends IDisposable
Not applicable.
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.
'The following example demonstrates the implementation of 'ISite, IComponent, and IContainer for use in a simple library container. ' 'This example imports the System, System.ComponentModel, and System.Collections 'namespaces. '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 Implements ISite Private m_curComponent As IComponent Private m_curContainer As IContainer Private m_bDesignMode As Boolean Private m_ISBNCmpName As String Public Sub New(ByVal actvCntr As IContainer, ByVal prntCmpnt As IComponent) m_curComponent = prntCmpnt m_curContainer = actvCntr m_bDesignMode = False m_ISBNCmpName = Nothing End Sub 'Support the ISite interface. Public ReadOnly Property Component() As IComponent Implements ISite.Component Get Return m_curComponent End Get End Property Public ReadOnly Property Container() As IContainer Implements ISite.Container Get Return m_curContainer End Get End Property Public ReadOnly Property DesignMode() As Boolean Implements ISite.DesignMode Get Return m_bDesignMode End Get End Property Public Property Name() As String Implements ISite.Name Get Return m_ISBNCmpName End Get Set(ByVal Value As String) m_ISBNCmpName = Value End Set End Property 'Support the IServiceProvider interface. Public Function GetService(ByVal serviceType As Type) As Object Implements IServiceProvider.GetService 'This example does not use any service object. GetService = Nothing End Function End Class 'The BookComponent class represents the book component of the library container. Class BookComponent Implements IComponent Public Event Disposed As EventHandler Implements IComponent.Disposed Private m_curISBNSite As ISite Private m_bookTitle As String Private m_bookAuthor As String Public Sub New(ByVal Title As String, ByVal Author As String) m_curISBNSite = Nothing m_bookTitle = Title m_bookAuthor = Author End Sub Public ReadOnly Property Title() As String Get Return m_bookTitle End Get End Property Public ReadOnly Property Author() As String Get Return m_bookAuthor End Get End Property Public Sub Dispose() Implements IDisposable.Dispose 'There is nothing to clean. RaiseEvent Disposed(Me, EventArgs.Empty) End Sub Public Property Site() As ISite Implements IComponent.Site Get Return m_curISBNSite End Get Set(ByVal Value As ISite) m_curISBNSite = Value End Set End Property Public Overloads Function Equals(ByVal cmp As Object) As Boolean Dim cmpObj As BookComponent = CType(cmp, BookComponent) If (Me.Title.Equals(cmpObj.Title) And Me.Author.Equals(cmpObj.Author)) Then Equals = True Else Equals = False End If End Function Public Overrides Function GetHashCode() As Integer GetHashCode = MyBase.GetHashCode() End Function End Class
/// <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 implements ISite
{
private IComponent mCurComponent;
private IContainer mCurContainer;
private boolean mbDesignMode;
private String mISBNCmpName;
public ISBNSite(IContainer actvCntr, IComponent prntCmpnt)
{
mCurComponent = prntCmpnt;
mCurContainer = actvCntr;
mbDesignMode = false;
mISBNCmpName = null;
} //ISBNSite
//Support the ISite interface.
/** @property
*/
public IComponent get_Component()
{
return mCurComponent;
} //get_Component
/** @property
*/
public IContainer get_Container()
{
return mCurContainer;
} //get_Container
/** @property
*/
public boolean get_DesignMode()
{
return mbDesignMode;
} //get_DesignMode
/** @property
*/
public String get_Name()
{
return mISBNCmpName;
} //get_Name
/** @property
*/
public void set_Name(String value)
{
mISBNCmpName = value;
} //set_Name
// Support the IServiceProvider interface.
public Object GetService(Type serviceType)
{
// This example does not use any service object.
return null;
} //GetService
} //ISBNSite
// The BookComponent class represents the book component of the library
// container. This class implements the IComponent interface.
class BookComponent implements IComponent
{
public EventHandler disposed = null;
/** @event
*/
public void add_Disposed(EventHandler p)
{
disposed = (EventHandler)System.Delegate.Combine(disposed, p);
} //add_Disposed
/** @event
*/
public void remove_Disposed(EventHandler p)
{
disposed = (EventHandler)System.Delegate.Remove(disposed, p);
} //remove_Disposed
private ISite mCurISBNSite;
private String mBookTitle;
private String mBookAuthor;
public BookComponent(String title, String author)
{
mCurISBNSite = null;
disposed = null;
mBookTitle = title;
mBookAuthor = author;
} //BookComponent
/** @property
*/
public String get_Title()
{
return mBookTitle;
} //get_Title
/** @property
*/
public String get_Author()
{
return mBookAuthor;
} //get_Author
public void Dispose()
{
// There is nothing to clean.
if (disposed != null) {
disposed.Invoke(this, EventArgs.Empty);
}
} //Dispose
/** @property
*/
public ISite get_Site()
{
return mCurISBNSite;
} //get_Site
/** @property
*/
public void set_Site(ISite value)
{
mCurISBNSite = value;
} //set_Site
public boolean Equals(Object cmp)
{
BookComponent cmpObj = (BookComponent)cmp;
if (this.get_Title().Equals(cmpObj.get_Title()) && this.get_Author().
Equals(cmpObj.get_Author())) {
return true;
}
return false;
} //Equals
public int GetHashCode()
{
return super.GetHashCode();
} //GetHashCode
} //BookComponent
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.