ISite Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides functionality required by sites.
public interface class ISite : IServiceProviderpublic interface ISite : IServiceProvider[System.Runtime.InteropServices.ComVisible(true)]
public interface ISite : IServiceProvidertype ISite = interface
interface IServiceProvider[<System.Runtime.InteropServices.ComVisible(true)>]
type ISite = interface
interface IServiceProviderPublic Interface ISite
Implements IServiceProvider- Derived
- Attributes
- Implements
Examples
The following example demonstrates the implementation of ISite, IComponent, and IContainer for use in a library container.
/// <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();
}
}
'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
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.
Properties
| Component |
Gets the component associated with the ISite when implemented by a class. |
| Container |
Gets the IContainer associated with the ISite when implemented by a class. |
| DesignMode |
Determines whether the component is in design mode when implemented by a class. |
| Name |
Gets or sets the name of the component associated with the ISite when implemented by a class. |
Methods
| GetService(Type) |
Gets the service object of the specified type. (Inherited from IServiceProvider) |
Extension Methods
Applies to
See also
Colaborați cu noi pe GitHub
Sursa pentru acest conținut poate fi găsită pe GitHub, unde puteți, de asemenea, să creați și să consultați probleme și solicitări de tragere. Pentru mai multe informații, consultați ghidul nostru pentru colaboratori.
