AddInController Class

Provides access to an add-in for a variety of tasks.

System.Object
  System.AddIn.Hosting.AddInController

Namespace:  System.AddIn.Hosting
Assembly:  System.AddIn (in System.AddIn.dll)

'Declaration
Public NotInheritable Class AddInController

The AddInController type exposes the following members.

  NameDescription
Public propertyAddInEnvironmentGets an AddInEnvironment object.
Public propertyAppDomainGets the application domain that contains an add-in.
Public propertyTokenGets the token that represents the add-in.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodStatic memberGetAddInControllerObtains the controller for an add-in.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodShutdownDisables an add-in.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Use this class to perform the following tasks:

  • Use the AddInEnvironment property to obtain an AddInEnvironment object for an add-in. Then use that object to activate other add-ins in the same application domain and process as the original add-in.

  • Use the AppDomain property to obtain an AppDomain object for an add-in. Then use that object to activate other add-ins in the same application domain as the original add-in. Note that because of limitations in cross-process remoting, this scenario will not work with add-ins that are activated in a separate process.

  • Use the Token property to obtain an AddInToken object that represents an add-in.

  • Shut down an add-in with the Shutdown method.

To obtain the controller for an add-in, call the GetAddInController method and pass an instance of the add-in as its parameter.

The following example activates an add-in within the same environment as a previously activated add-in by using an AddInController object.

' Get the AddInController of a  
' currently activated add-in (CalcAddIn). 
Dim aiController As AddInController = AddInController.GetAddInController(CalcAddIn)

' Select another token. 
Dim selectedToken2 As AddInToken = ChooseAddIn(tokens)

' Activate a second add-in, CalcAddIn2, in the same 
' appliation domain and process as the first add-in by passing 
' the first add-in's AddInEnvironment object to the Activate method. 

Dim aiEnvironment As AddInEnvironment = aiController.AddInEnvironment
Dim CalcAddIn2 As Calculator = _
    selectedToken2.Activate(Of Calculator)(aiEnvironment)

' Get the AddInController for the second add-in to compare environments. 
Dim aiController2 As AddInController = AddInController.GetAddInController(CalcAddIn2)

Console.WriteLine("Add-ins in same application domain: {0}", _
    aiController.AppDomain.Equals(aiController2.AppDomain))
Console.WriteLine("Add-ins in same process: {0}", _
    aiEnvironment.Process.Equals(aiController2.AddInEnvironment.Process))

.NET Framework

Supported in: 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft