Export (0) Print
Expand All

IComponent Interface

Provides functionality required by all components.

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

'Declaration
<TypeConverterAttribute(GetType(ComponentConverter))> _
<ComVisibleAttribute(True)> _
Public Interface IComponent _
	Inherits IDisposable

The IComponent type exposes the following members.

  NameDescription
Public propertySupported by the XNA FrameworkSiteGets or sets the ISite associated with the IComponent.
Top

  NameDescription
Public methodSupported by the XNA FrameworkDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Top

  NameDescription
Public eventSupported by the XNA FrameworkDisposedRepresents the method that handles the Disposed event of a component.
Top

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft