Export (0) Print
Expand All

ISite Interface

Provides functionality required by sites.

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

[ComVisibleAttribute(true)]
public interface ISite : IServiceProvider

The ISite type exposes the following members.

  NameDescription
Public propertySupported by the XNA FrameworkComponentGets the component associated with the ISite when implemented by a class.
Public propertySupported by the XNA FrameworkContainerGets the IContainer associated with the ISite when implemented by a class.
Public propertySupported by the XNA FrameworkDesignModeDetermines whether the component is in design mode when implemented by a class.
Public propertySupported by the XNA FrameworkNameGets or sets the name of the component associated with the ISite when implemented by a class.
Top

  NameDescription
Public methodSupported by the XNA FrameworkGetServiceGets the service object of the specified type. (Inherited from IServiceProvider.)
Top

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. For more information about components, see Programming with Components.

Notes to Implementers

To be a site, a class must implement the ISite interface.

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();
		}
	}

.NET Framework

Supported in: 4.5.3, 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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft