SingletonEventSource<TDerived> Class

Visual Studio 2015

Visual Studio 2013

The base class for singleton event sources. Classes that are derived from SingletonEventSource should expose static events rather than instance events.

Namespace: Microsoft.VisualStudio.Shell.Events
Assembly: Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)

Inheritance Hierarchy

System::Object
  Microsoft.VisualStudio.Shell.Events::EventSource
    Microsoft.VisualStudio.Shell.Events::SingletonEventSource<TDerived>
      Microsoft.VisualStudio.Shell.Events::SolutionEvents

Syntax

C++

generic<typename TDerived>
where TDerived : gcnew()
public ref class SingletonEventSource abstract : EventSource

Type Parameters

TDerived: The type of the derived event source.

Constructors

	Name	Description
	SingletonEventSource<TDerived>()	Instantiates a new instance of SingletonEventSource.

Properties

	Name	Description
	Instance	The singleton instance of the event source.
	IsAdvised	(Inherited from EventSource.)
	IsInstanceCreated	Determines whether the singleton instance of TDerived has been created yet.

Methods

	Name	Description
	AddHandler(Delegate^, String^)	Adds an event handler for the specified key(Inherited from EventSource.)
	Advise()	Called when the first event sink is added to the event source. The derived class should advise the VS events it is wrapping at this point. This method is always called on the UI thread.(Inherited from EventSource.)
	Equals(Object^)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHandler(String^)	Gets the handler for the given key, or null if none exists.(Inherited from EventSource.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	HasHandler(String^)	Determines whether the event identified by the specified key has at least one handler.(Inherited from EventSource.)
	MemberwiseClone()	(Inherited from Object.)
	RaiseEvent<TEventArgs>(Object^, TEventArgs, String^)	Raises the specified event. All event handlers are called, regardless of whether an individual handler throws an exception.(Inherited from EventSource.)
	RemoveHandler(Delegate^, String^)	Removes an event handler for the event specified by key.(Inherited from EventSource.)
	ToString()	(Inherited from Object.)
	Unadvise()	Called when the last event sink is removed from the event source. The derived class should unadvise the VS events it is wrapping at this point. This method is always called on the UI thread.(Inherited from EventSource.)

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.