mcs/class/System.ComponentModel.Composition/Documentation/en/System.ComponentModel.Composition.Hosting/AggregateExportProvider.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="AggregateExportProvider" FullName="System.ComponentModel.Composition.Hosting.AggregateExportProvider">
   3   <TypeSignature Language="C#" Value="public class AggregateExportProvider : System.ComponentModel.Composition.Hosting.ExportProvider, IDisposable" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AggregateExportProvider extends System.ComponentModel.Composition.Hosting.ExportProvider implements class System.IDisposable" />
   5   <AssemblyInfo>
   6     <AssemblyName>System.ComponentModel.Composition</AssemblyName>
   7     <AssemblyVersion>4.0.0.0</AssemblyVersion>
   8   </AssemblyInfo>
   9   <Base>
  10     <BaseTypeName>System.ComponentModel.Composition.Hosting.ExportProvider</BaseTypeName>
  11   </Base>
  12   <Interfaces>
  13     <Interface>
  14       <InterfaceName>System.IDisposable</InterfaceName>
  15     </Interface>
  16   </Interfaces>
  17   <Docs>
  18     <remarks>To be added.</remarks>
  19     <summary>
  20       <attribution license="cc4" from="Microsoft" modified="false" />
  21       <para>Retrieves exports provided by a collection of <see cref="T:System.ComponentModel.Composition.Hosting.ExportProvider" /> objects.</para>
  22     </summary>
  23   </Docs>
  24   <Members>
  25     <Member MemberName=".ctor">
  26       <MemberSignature Language="C#" Value="public AggregateExportProvider (System.Collections.Generic.IEnumerable&lt;System.ComponentModel.Composition.Hosting.ExportProvider&gt; providers);" />
  27       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IEnumerable`1&lt;class System.ComponentModel.Composition.Hosting.ExportProvider&gt; providers) cil managed" />
  28       <MemberType>Constructor</MemberType>
  29       <AssemblyInfo>
  30         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  31       </AssemblyInfo>
  32       <Parameters>
  33         <Parameter Name="providers" Type="System.Collections.Generic.IEnumerable&lt;System.ComponentModel.Composition.Hosting.ExportProvider&gt;" />
  34       </Parameters>
  35       <Docs>
  36         <remarks>
  37           <attribution license="cc4" from="Microsoft" modified="false" />
  38           <para>The <see cref="T:System.ComponentModel.Composition.Hosting.AggregateExportProvider" /> class consults the providers in the order in which they have been specified when it calls <see cref="M:System.ComponentModel.Composition.Hosting.ExportProvider.GetExports(System.ComponentModel.Composition.Primitives.ImportDefinition)" />. </para>
  39           <para>The <see cref="T:System.ComponentModel.Composition.Hosting.AggregateExportProvider" /> does not take ownership of the specified providers. That is, it tries to dispose of any of the providers when it is disposed.</para>
  40         </remarks>
  41         <summary>
  42           <attribution license="cc4" from="Microsoft" modified="false" />
  43           <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateExportProvider" /> class.</para>
  44         </summary>
  45         <param name="providers">
  46           <attribution license="cc4" from="Microsoft" modified="false" />The prioritized list of export providers. The providers are consulted in the order in which they are supplied.</param>
  47       </Docs>
  48     </Member>
  49     <Member MemberName=".ctor">
  50       <MemberSignature Language="C#" Value="public AggregateExportProvider (System.ComponentModel.Composition.Hosting.ExportProvider[] providers);" />
  51       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.ComponentModel.Composition.Hosting.ExportProvider[] providers) cil managed" />
  52       <MemberType>Constructor</MemberType>
  53       <AssemblyInfo>
  54         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  55       </AssemblyInfo>
  56       <Parameters>
  57         <Parameter Name="providers" Type="System.ComponentModel.Composition.Hosting.ExportProvider[]">
  58           <Attributes>
  59             <Attribute>
  60               <AttributeName>System.ParamArray</AttributeName>
  61             </Attribute>
  62           </Attributes>
  63         </Parameter>
  64       </Parameters>
  65       <Docs>
  66         <remarks>
  67           <attribution license="cc4" from="Microsoft" modified="false" />
  68           <para>The <see cref="T:System.ComponentModel.Composition.Hosting.AggregateExportProvider" /> class consults the providers in the order in which they have been specified when it calls <see cref="M:System.ComponentModel.Composition.Hosting.ExportProvider.GetExports(System.ComponentModel.Composition.Primitives.ImportDefinition)" />. </para>
  69           <para>The <see cref="T:System.ComponentModel.Composition.Hosting.AggregateExportProvider" /> does not take ownership of the specified providers.  That is, it tries to dispose of any of the providers when it is disposed.</para>
  70         </remarks>
  71         <summary>
  72           <attribution license="cc4" from="Microsoft" modified="false" />
  73           <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateExportProvider" /> class.</para>
  74         </summary>
  75         <param name="providers">
  76           <attribution license="cc4" from="Microsoft" modified="false" />The prioritized list of export providers.</param>
  77       </Docs>
  78     </Member>
  79     <Member MemberName="Dispose">
  80       <MemberSignature Language="C#" Value="public void Dispose ();" />
  81       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
  82       <MemberType>Method</MemberType>
  83       <AssemblyInfo>
  84         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  85       </AssemblyInfo>
  86       <ReturnValue>
  87         <ReturnType>System.Void</ReturnType>
  88       </ReturnValue>
  89       <Parameters />
  90       <Docs>
  91         <remarks>
  92           <attribution license="cc4" from="Microsoft" modified="false" />
  93           <para>Call Dispose when you are finished using the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateExportProvider" />. The Dispose method leaves the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateExportProvider" /> in an unusable state. After calling Dispose, you must release all references to the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateExportProvider" /> so the garbage collector can reclaim the memory that the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateExportProvider" /> was occupying.</para>
  94           <para>For more information, see <format type="text/html"><a href="A17B0066-71C2-4BA4-9822-8E19332FC213">Cleaning Up Unmanaged Resources</a></format> and <format type="text/html"><a href="eb4e1af0-3b48-4fbc-ad4e-fc2f64138bf9">Implementing a Dispose Method</a></format>.</para>
  95           <block subset="none" type="note">
  96             <para>Always call Dispose before you release your last reference to the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateExportProvider" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateExportProvider" /> object's Finalize method.</para>
  97           </block>
  98         </remarks>
  99         <summary>
 100           <attribution license="cc4" from="Microsoft" modified="false" />
 101           <para>Releases all resources used by the current instance of the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateExportProvider" /> class. </para>
 102         </summary>
 103       </Docs>
 104     </Member>
 105     <Member MemberName="Dispose">
 106       <MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
 107       <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
 108       <MemberType>Method</MemberType>
 109       <AssemblyInfo>
 110         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 111       </AssemblyInfo>
 112       <ReturnValue>
 113         <ReturnType>System.Void</ReturnType>
 114       </ReturnValue>
 115       <Parameters>
 116         <Parameter Name="disposing" Type="System.Boolean" />
 117       </Parameters>
 118       <Docs>
 119         <remarks>To be added.</remarks>
 120         <summary>
 121           <attribution license="cc4" from="Microsoft" modified="false" />
 122           <para>Releases the unmanaged resources used by the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateExportProvider" /> class and optionally releases the managed resources. </para>
 123         </summary>
 124         <param name="disposing">
 125           <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param>
 126       </Docs>
 127     </Member>
 128     <Member MemberName="GetExportsCore">
 129       <MemberSignature Language="C#" Value="protected override System.Collections.Generic.IEnumerable&lt;System.ComponentModel.Composition.Primitives.Export&gt; GetExportsCore (System.ComponentModel.Composition.Primitives.ImportDefinition definition, System.ComponentModel.Composition.Hosting.AtomicComposition atomicComposition);" />
 130       <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.Collections.Generic.IEnumerable`1&lt;class System.ComponentModel.Composition.Primitives.Export&gt; GetExportsCore(class System.ComponentModel.Composition.Primitives.ImportDefinition definition, class System.ComponentModel.Composition.Hosting.AtomicComposition atomicComposition) cil managed" />
 131       <MemberType>Method</MemberType>
 132       <AssemblyInfo>
 133         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 134       </AssemblyInfo>
 135       <ReturnValue>
 136         <ReturnType>System.Collections.Generic.IEnumerable&lt;System.ComponentModel.Composition.Primitives.Export&gt;</ReturnType>
 137       </ReturnValue>
 138       <Parameters>
 139         <Parameter Name="definition" Type="System.ComponentModel.Composition.Primitives.ImportDefinition" />
 140         <Parameter Name="atomicComposition" Type="System.ComponentModel.Composition.Hosting.AtomicComposition" />
 141       </Parameters>
 142       <Docs>
 143         <remarks>
 144           <attribution license="cc4" from="Microsoft" modified="false" />
 145           <para>Implementers should not treat cardinality-related mismatches as errors and are not expected to throw exceptions in those cases.</para>
 146           <para>For example, if the import requests exactly one export and the provider has either no matching exports or more than one, the method should return an empty <see cref="T:System.Collections.Generic.IEnumerable`1" /> collection of <see cref="T:System.ComponentModel.Composition.Primitives.Export" />.</para>
 147         </remarks>
 148         <summary>
 149           <attribution license="cc4" from="Microsoft" modified="false" />
 150           <para>Gets all the exports that match the conditions of the specified import.</para>
 151         </summary>
 152         <returns>
 153           <attribution license="cc4" from="Microsoft" modified="false" />
 154           <para>A collection that contains all the exports that match the specified condition.</para>
 155         </returns>
 156         <param name="definition">
 157           <attribution license="cc4" from="Microsoft" modified="false" />The conditions of the <see cref="T:System.ComponentModel.Composition.Primitives.Export" /> objects to be returned.</param>
 158         <param name="atomicComposition">
 159           <attribution license="cc4" from="Microsoft" modified="false" />The transactional container for the composition.</param>
 160       </Docs>
 161     </Member>
 162     <Member MemberName="Providers">
 163       <MemberSignature Language="C#" Value="public System.Collections.ObjectModel.ReadOnlyCollection&lt;System.ComponentModel.Composition.Hosting.ExportProvider&gt; Providers { get; }" />
 164       <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.ReadOnlyCollection`1&lt;class System.ComponentModel.Composition.Hosting.ExportProvider&gt; Providers" />
 165       <MemberType>Property</MemberType>
 166       <AssemblyInfo>
 167         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 168       </AssemblyInfo>
 169       <ReturnValue>
 170         <ReturnType>System.Collections.ObjectModel.ReadOnlyCollection&lt;System.ComponentModel.Composition.Hosting.ExportProvider&gt;</ReturnType>
 171       </ReturnValue>
 172       <Docs>
 173         <value>To be added.</value>
 174         <remarks>To be added.</remarks>
 175         <summary>
 176           <attribution license="cc4" from="Microsoft" modified="false" />
 177           <para>Gets a collection that contains the providers that the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateExportProvider" /> object aggregates.</para>
 178         </summary>
 179       </Docs>
 180     </Member>
 181   </Members>
 182 </Type>