Export (0) Print
Expand All

CompositionContainer Class

Manages the composition of parts.

System.Object
  System.ComponentModel.Composition.Hosting.ExportProvider
    System.ComponentModel.Composition.Hosting.CompositionContainer

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

type CompositionContainer =  
    class 
        inherit ExportProvider 
        interface ICompositionService 
        interface IDisposable 
    end

The CompositionContainer type exposes the following members.

  NameDescription
Public methodSupported by Portable Class LibraryCompositionContainer()Initializes a new instance of the CompositionContainer class.
Public methodSupported by Portable Class LibraryCompositionContainer(ExportProvider[])Initializes a new instance of the CompositionContainer class with the specified export providers.
Public methodSupported by Portable Class LibraryCompositionContainer(ComposablePartCatalog, ExportProvider[])Initializes a new instance of the CompositionContainer class with the specified catalog and export providers.
Public methodCompositionContainer(CompositionOptions, ExportProvider[])Initializes a new instance of the CompositionContainer class with the specified export providers and options.
Public methodSupported by Portable Class LibraryCompositionContainer(ComposablePartCatalog, Boolean, ExportProvider[])Initializes a new instance of the CompositionContainer class with the specified catalog, thread-safe mode, and export providers.
Public methodCompositionContainer(ComposablePartCatalog, CompositionOptions, ExportProvider[])Initializes a new instance of the CompositionContainer class with the specified catalog, options, and export providers.
Top

  NameDescription
Public propertySupported by Portable Class LibraryCatalogGets the ComposablePartCatalog that provides the container access to Export objects.
Public propertySupported by Portable Class LibraryProvidersGets the export providers that provide the container access to additional ComposablePartCatalog objects.
Top

  NameDescription
Public methodSupported by Portable Class LibraryComposeAdds or removes the parts in the specified CompositionBatch from the container and executes composition.
Public methodSupported by Portable Class LibraryDispose()Releases all resources used by the current instance of the CompositionContainer class.
Protected methodSupported by Portable Class LibraryDispose(Boolean)Releases the unmanaged resources used by the CompositionContainer and optionally releases the managed resources.
Public methodSupported by Portable Class LibraryEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetExport(T)()Returns the export with the contract name derived from the specified type parameter. If there is not exactly one matching export, an exception is thrown. (Inherited from ExportProvider.)
Public methodSupported by Portable Class LibraryGetExport(T)(String)Returns the export with the specified contract name. If there is not exactly one matching export, an exception is thrown. (Inherited from ExportProvider.)
Public methodSupported by Portable Class LibraryGetExportedValue(T)()Returns the exported object with the contract name derived from the specified type parameter. If there is not exactly one matching exported object, an exception is thrown. (Inherited from ExportProvider.)
Public methodSupported by Portable Class LibraryGetExportedValue(T)(String)Returns the exported object with the specified contract name. If there is not exactly one matching exported object, an exception is thrown. (Inherited from ExportProvider.)
Public methodSupported by Portable Class LibraryGetExportedValueOrDefault(T)()Gets the exported object with the contract name derived from the specified type parameter or the default value for the specified type, or throws an exception if there is more than one matching exported object. (Inherited from ExportProvider.)
Public methodSupported by Portable Class LibraryGetExportedValueOrDefault(T)(String)Gets the exported object with the specified contract name or the default value for the specified type, or throws an exception if there is more than one matching exported object. (Inherited from ExportProvider.)
Public methodSupported by Portable Class LibraryGetExportedValues(T)()Gets all the exported objects with the contract name derived from the specified type parameter. (Inherited from ExportProvider.)
Public methodSupported by Portable Class LibraryGetExportedValues(T)(String)Gets all the exported objects with the specified contract name. (Inherited from ExportProvider.)
Public methodSupported by Portable Class LibraryGetExports(ImportDefinition)Gets all exports that match the conditions of the specified import definition. (Inherited from ExportProvider.)
Public methodSupported by Portable Class LibraryGetExports(ImportDefinition, AtomicComposition)Gets all exports that match the conditions of the specified import definition and composition. (Inherited from ExportProvider.)
Public methodSupported by Portable Class LibraryGetExports(Type, Type, String)Gets all the exports with the specified contract name. (Inherited from ExportProvider.)
Public methodSupported by Portable Class LibraryGetExports(T)()Gets all the exports with the contract name derived from the specified type parameter. (Inherited from ExportProvider.)
Public methodSupported by Portable Class LibraryGetExports(T)(String)Gets all the exports with the specified contract name. (Inherited from ExportProvider.)
Protected methodSupported by Portable Class LibraryGetExportsCoreReturns a collection of all exports that match the conditions in the specified ImportDefinition object. (Overrides ExportProvider.GetExportsCore(ImportDefinition, AtomicComposition).)
Public methodSupported by Portable Class LibraryGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryOnExportsChangedRaises the ExportsChanged event. (Inherited from ExportProvider.)
Protected methodSupported by Portable Class LibraryOnExportsChangingRaises the ExportsChanging event. (Inherited from ExportProvider.)
Public methodSupported by Portable Class LibraryReleaseExport(Export)Releases the specified Export object from the CompositionContainer.
Public methodSupported by Portable Class LibraryReleaseExport(T)(Lazy(T))Removes the specified export from composition and releases its resources if possible.
Public methodSupported by Portable Class LibraryReleaseExports(IEnumerable(Export))Releases a set of Export objects from the CompositionContainer.
Public methodSupported by Portable Class LibraryReleaseExports(T)(IEnumerable(Lazy(T)))Removes a collection of exports from composition and releases their resources if possible.
Public methodSupported by Portable Class LibraryReleaseExports(T, TMetadataView)(IEnumerable(Lazy(T, TMetadataView)))Removes a collection of exports from composition and releases their resources if possible.
Public methodSupported by Portable Class LibrarySatisfyImportsOnceSatisfies the imports of the specified ComposablePart object without registering it for recomposition.
Public methodSupported by Portable Class LibraryToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodSupported by Portable Class LibraryTryGetExportsGets all the exports that match the conditions of the specified import. (Inherited from ExportProvider.)
Top

  NameDescription
Public eventSupported by Portable Class LibraryExportsChangedOccurs when the exports in the ExportProvider change. (Inherited from ExportProvider.)
Public eventSupported by Portable Class LibraryExportsChangingOccurs when the provided exports are changing. (Inherited from ExportProvider.)
Top

  NameDescription
Public Extension MethodSupported by Portable Class LibraryComposeExportedValue(T)(T)Overloaded. Creates a part from the specified value and composes it in the specified composition container. (Defined by AttributedModelServices.)
Public Extension MethodSupported by Portable Class LibraryComposeExportedValue(T)(String, T)Overloaded. Creates a part from the specified object under the specified contract name and composes it in the specified composition container. (Defined by AttributedModelServices.)
Public Extension MethodSupported by Portable Class LibraryComposePartsCreates composable parts from an array of attributed objects and composes them in the specified composition container. (Defined by AttributedModelServices.)
Public Extension MethodSupported by Portable Class LibrarySatisfyImportsOnce(Object)Overloaded. Composes the specified part by using the specified composition service, with recomposition disabled. (Defined by AttributedModelServices.)
Public Extension MethodSatisfyImportsOnce(Object, ReflectionContext)Overloaded. Composes the specified part by using the specified composition service, with recomposition disabled and using the specified reflection context. (Defined by AttributedModelServices.)
Top

A CompositionContainer object serves two major purposes in an application. First, it keeps track of which parts are available for composition and what their dependencies are, and performs composition whenever the set of available parts changes. Second, it provides the methods by which the application gets instances of composed parts or fills the dependencies of a composable part.

Important noteImportant

This type implements the IDisposable interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its Dispose method in a try/catch block. To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). For more information, see the “Using an Object that Implements IDisposable” section in the IDisposable interface topic.

Parts can be made available to the container either directly or through the Catalog property. All the parts discoverable in this ComposablePartCatalog are available to the container to fulfill imports, along with any parts added directly.

The Compose method allows instantiated parts to be added to an existing container. Assuming composition is successful, these parts will have their imports filled with parts retrieved from the container, and their exports will be available to other parts. Imports marked as recomposable will be registered for recomposition.

The SatisfyImportsOnce method allows a part to have its imports filled without being added to the container. If the composition is successful, the part's imports will be filled, but the part's exports will not be available to other parts and no imports will be registered for recomposition.

CompositionContainer objects should always be disposed. When the Dispose method is called, the CompositionContainer object also disposes all the parts that it has created.

A CompositionContainer object that can be accessed from multiple threads must be constructed with the isThreadSafe parameter set to true, using the CompositionContainer(ComposablePartCatalog, Boolean, ExportProvider[]) constructor. Performance will be slightly slower when isThreadSafe is true, so we recommend that you set this parameter to false in single-threaded scenarios. The default is false.

Caution noteCaution

A CompositionContainer should never import itself, or a part that has a reference to it. Such a reference could allow an untrusted part to gain access all the parts in the container.

In the following example, a CompositionContainer object is initialized with a catalog and is used to fill the imports of a part. This example uses the Attributed Programming Model.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

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.
Show:
© 2014 Microsoft