ObjectWithSite Class

Article
02/23/2011

Provides a simplified way to support communication between an object and its site in the container.

Inheritance Hierarchy

Namespace: Microsoft.VisualStudio.Data
Assembly: Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)

Syntax

'Declaration
Public Class ObjectWithSite _
    Implements IObjectWithSite

public class ObjectWithSite : IObjectWithSite

public ref class ObjectWithSite : IObjectWithSite

type ObjectWithSite =  
    class
        interface IObjectWithSite
    end

public class ObjectWithSite implements IObjectWithSite

The ObjectWithSite type exposes the following members.

Constructors

	Name	Description
	ObjectWithSite()	Class constructor. Initializes a new instance of the ObjectWithSite class.
	ObjectWithSite(Object)	Class constructor. Initializes a new instance of the ObjectWithSite class with a specified site object.

Top

Properties

	Name	Description
	Site	Retrieves or sets the object site.

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnSiteChanged	Raises the SiteChanged event.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	SiteChanged	Event that is raised when the Site property is changed.

Top

Explicit Interface Implementations

	Name	Description
	IObjectWithSite.GetSite	Retrieves the last site set using the IObjectWithSite.SetSite method. In cases where there is no known site, the object returns an exception.
	IObjectWithSite.SetSite	Provides the site's pointer to the site object.

Top

Remarks

This class provides a simple implementation of the IObjectWithSite interface. Following managed coding standards, it provides an event that is raised when the site is changed. This allows a client or any derived class to apply custom logic when changes occur to the object site.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.