Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

ISite Interface

Provides functionality required by sites.

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

System.IServiceProvider
   System.ComponentModel.ISite

[Visual Basic]
<ComVisible(True)>
Public Interface ISite
   Inherits IServiceProvider
[C#]
[ComVisible(true)]
public interface ISite : IServiceProvider
[C++]
[ComVisible(true)]
public __gc __interface ISite : public IServiceProvider
[JScript]
public
   ComVisible(true)
interface ISite implements IServiceProvider

Remarks

Sites bind a Component to a Container and enable communication between them, as well as provide a way for the container to manage its components.

Sites can also serve as a repository for container-specific, per-component information, such as the component name.

Notes to Implementers:  To be a site, a class must implement the ISite interface.

Example

[Visual Basic, C#, C++] The following example demonstrates the implementation of ISite, IComponent, and IContainer for use in a library container.

[Visual Basic] 
'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 ISite.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 IComponent.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

[C#] 
/// <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();
    }
}

[C++] 
/// <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
__gc class ISBNSite : public ISite
{
private:

    IComponent* m_curComponent;
    IContainer* m_curContainer;
    bool m_bDesignMode;
    String* m_ISBNCmpName;


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

    //Support the ISite interface.
    __property virtual IComponent* get_Component()
    {
            return m_curComponent;
    }

    __property virtual IContainer* get_Container()
    {
            return m_curContainer;
    }

    __property virtual bool get_DesignMode()
    {
            return m_bDesignMode;
    }

    __property virtual String* get_Name()
    {
            return m_ISBNCmpName;
    }

    __property virtual void set_Name( String* value )
    {
            m_ISBNCmpName = value;
    }

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

};

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

// This class implements the IComponent interface.

__gc class BookComponent : public IComponent
{
private:

    ISite* m_curISBNSite;
    String* m_bookTitle;
    String* m_bookAuthor;

public:

    __event virtual EventHandler* Disposed;

    BookComponent(String* Title, String* Author)
    {
        m_curISBNSite = 0;
        Disposed = 0;
        m_bookTitle = Title;
        m_bookAuthor = Author;
    }

    __property String* get_Title()
    {
            return m_bookTitle;
    }

    __property String* get_Author()
    {
            return m_bookAuthor;
    }

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

    __property virtual ISite* get_Site()
    {
            return m_curISBNSite;
    }

    __property virtual void set_Site( ISite* value )
    {
            m_curISBNSite = value;
    }

    bool Equals(Object* cmp)
    {
        BookComponent* cmpObj = __try_cast<BookComponent*>(cmp);
        return (this->Title->Equals(cmpObj->Title) && this->Author->Equals(cmpObj->Author));
    }

    int GetHashCode()
    {
        return IComponent::GetHashCode();
    }
};

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Namespace: System.ComponentModel

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

Assembly: System (in System.dll)

See Also

ISite Members | System.ComponentModel Namespace | Component | IComponent | Container | IContainer

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.