This documentation is archived and is not being maintained.

AddInEnvironment Class

Provides access to the application domain and process of an add-in.


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

public sealed class AddInEnvironment

The AddInEnvironment type exposes the following members.

Public methodAddInEnvironmentInitializes a new instance of the AddInEnvironment class.

Public propertyProcessGets the AddInProcess object that represents the process in which the add-in is running.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Use this class to load add-ins into a desired environment, which can be one of the following:

  • An existing application domain for which you have the AppDomain object.

  • An application domain that was automatically generated to activate an add-in.

  • An existing external process.

To obtain the AddInEnvironment object for an add-in, pass the add-in's application domain to the AddInEnvironment class constructor. Alternatively, you can use the AddInEnvironment property of the AddInController class to obtain the add-in's AddInEnvironment object.

After you obtain the AddInEnvironment object, you can do the following:

  • Pass that AddInEnvironment object to the appropriate Activate method overload. The add-in will be activated in the application domain and process that is represented by the AddInEnvironment object.

  • Use the Process property to obtain an AddInProcess object. Then pass that object to the appropriate Activate method overload. The add-in will be activated in the process that is represented by the AddInProcess object but in a new application domain.

.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.