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

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="CatalogExportProvider" FullName="System.ComponentModel.Composition.Hosting.CatalogExportProvider">
   3   <TypeSignature Language="C#" Value="public class CatalogExportProvider : System.ComponentModel.Composition.Hosting.ExportProvider, IDisposable" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CatalogExportProvider 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 from a catalog.</para>
  22     </summary>
  23   </Docs>
  24   <Members>
  25     <Member MemberName=".ctor">
  26       <MemberSignature Language="C#" Value="public CatalogExportProvider (System.ComponentModel.Composition.Primitives.ComposablePartCatalog catalog);" />
  27       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.ComponentModel.Composition.Primitives.ComposablePartCatalog catalog) cil managed" />
  28       <MemberType>Constructor</MemberType>
  29       <AssemblyInfo>
  30         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  31       </AssemblyInfo>
  32       <Parameters>
  33         <Parameter Name="catalog" Type="System.ComponentModel.Composition.Primitives.ComposablePartCatalog" />
  34       </Parameters>
  35       <Docs>
  36         <remarks>To be added.</remarks>
  37         <summary>
  38           <attribution license="cc4" from="Microsoft" modified="false" />
  39           <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Hosting.CatalogExportProvider" /> class with the specified catalog.</para>
  40         </summary>
  41         <param name="catalog">
  42           <attribution license="cc4" from="Microsoft" modified="false" />The catalog that the <see cref="T:System.ComponentModel.Composition.Hosting.CatalogExportProvider" /> uses to produce <see cref="T:System.ComponentModel.Composition.Primitives.Export" /> objects.</param>
  43       </Docs>
  44     </Member>
  45     <Member MemberName=".ctor">
  46       <MemberSignature Language="C#" Value="public CatalogExportProvider (System.ComponentModel.Composition.Primitives.ComposablePartCatalog catalog, bool isThreadSafe);" />
  47       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.ComponentModel.Composition.Primitives.ComposablePartCatalog catalog, bool isThreadSafe) cil managed" />
  48       <MemberType>Constructor</MemberType>
  49       <AssemblyInfo>
  50         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  51       </AssemblyInfo>
  52       <Parameters>
  53         <Parameter Name="catalog" Type="System.ComponentModel.Composition.Primitives.ComposablePartCatalog" />
  54         <Parameter Name="isThreadSafe" Type="System.Boolean" />
  55       </Parameters>
  56       <Docs>
  57         <remarks>To be added.</remarks>
  58         <summary>
  59           <attribution license="cc4" from="Microsoft" modified="false" />
  60           <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Hosting.CatalogExportProvider" /> class with the specified catalog and optional thread-safe mode. </para>
  61         </summary>
  62         <param name="catalog">
  63           <attribution license="cc4" from="Microsoft" modified="false" />The catalog that the <see cref="T:System.ComponentModel.Composition.Hosting.CatalogExportProvider" /> uses to produce <see cref="T:System.ComponentModel.Composition.Primitives.Export" /> objects.</param>
  64         <param name="isThreadSafe">
  65           <attribution license="cc4" from="Microsoft" modified="false" />true if this object must be thread-safe; otherwise, false.</param>
  66       </Docs>
  67     </Member>
  68     <Member MemberName=".ctor">
  69       <MemberSignature Language="C#" Value="public CatalogExportProvider (System.ComponentModel.Composition.Primitives.ComposablePartCatalog catalog, System.ComponentModel.Composition.Hosting.CompositionOptions compositionOptions);" />
  70       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.ComponentModel.Composition.Primitives.ComposablePartCatalog catalog, valuetype System.ComponentModel.Composition.Hosting.CompositionOptions compositionOptions) cil managed" />
  71       <MemberType>Constructor</MemberType>
  72       <AssemblyInfo>
  73         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  74       </AssemblyInfo>
  75       <Parameters>
  76         <Parameter Name="catalog" Type="System.ComponentModel.Composition.Primitives.ComposablePartCatalog" />
  77         <Parameter Name="compositionOptions" Type="System.ComponentModel.Composition.Hosting.CompositionOptions" />
  78       </Parameters>
  79       <Docs>
  80         <remarks>To be added.</remarks>
  81         <summary>
  82           <attribution license="cc4" from="Microsoft" modified="false" />
  83           <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Hosting.CatalogExportProvider" /> class with the specified catalog and composition options.</para>
  84         </summary>
  85         <param name="catalog">
  86           <attribution license="cc4" from="Microsoft" modified="false" />The catalog that the <see cref="T:System.ComponentModel.Composition.Hosting.CatalogExportProvider" /> uses to produce <see cref="T:System.ComponentModel.Composition.Primitives.Export" /> objects.</param>
  87         <param name="compositionOptions">
  88           <attribution license="cc4" from="Microsoft" modified="false" />Options that determine the behavior of this provider.</param>
  89       </Docs>
  90     </Member>
  91     <Member MemberName="Catalog">
  92       <MemberSignature Language="C#" Value="public System.ComponentModel.Composition.Primitives.ComposablePartCatalog Catalog { get; }" />
  93       <MemberSignature Language="ILAsm" Value=".property instance class System.ComponentModel.Composition.Primitives.ComposablePartCatalog Catalog" />
  94       <MemberType>Property</MemberType>
  95       <AssemblyInfo>
  96         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  97       </AssemblyInfo>
  98       <ReturnValue>
  99         <ReturnType>System.ComponentModel.Composition.Primitives.ComposablePartCatalog</ReturnType>
 100       </ReturnValue>
 101       <Docs>
 102         <value>To be added.</value>
 103         <remarks>To be added.</remarks>
 104         <summary>
 105           <attribution license="cc4" from="Microsoft" modified="false" />
 106           <para>Gets the catalog that is used to provide exports.</para>
 107         </summary>
 108       </Docs>
 109     </Member>
 110     <Member MemberName="Dispose">
 111       <MemberSignature Language="C#" Value="public void Dispose ();" />
 112       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
 113       <MemberType>Method</MemberType>
 114       <AssemblyInfo>
 115         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 116       </AssemblyInfo>
 117       <ReturnValue>
 118         <ReturnType>System.Void</ReturnType>
 119       </ReturnValue>
 120       <Parameters />
 121       <Docs>
 122         <remarks>
 123           <attribution license="cc4" from="Microsoft" modified="false" />
 124           <para>Call Dispose when you are finished using the <see cref="T:System.ComponentModel.Composition.Hosting.CatalogExportProvider" />. The Dispose method leaves the <see cref="T:System.ComponentModel.Composition.Hosting.CatalogExportProvider" /> in an unusable state. After calling Dispose, you must release all references to the <see cref="T:System.ComponentModel.Composition.Hosting.CatalogExportProvider" /> so the garbage collector can reclaim the memory that the <see cref="T:System.ComponentModel.Composition.Hosting.CatalogExportProvider" /> was occupying.</para>
 125           <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>
 126           <block subset="none" type="note">
 127             <para>Always call Dispose before you release your last reference to the <see cref="T:System.ComponentModel.Composition.Hosting.CatalogExportProvider" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the <see cref="T:System.ComponentModel.Composition.Hosting.CatalogExportProvider" /> object's Finalize method.</para>
 128           </block>
 129         </remarks>
 130         <summary>
 131           <attribution license="cc4" from="Microsoft" modified="false" />
 132           <para>Releases all resources used by the current instance of the <see cref="T:System.ComponentModel.Composition.Hosting.CatalogExportProvider" /> class.</para>
 133         </summary>
 134       </Docs>
 135     </Member>
 136     <Member MemberName="Dispose">
 137       <MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
 138       <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
 139       <MemberType>Method</MemberType>
 140       <AssemblyInfo>
 141         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 142       </AssemblyInfo>
 143       <ReturnValue>
 144         <ReturnType>System.Void</ReturnType>
 145       </ReturnValue>
 146       <Parameters>
 147         <Parameter Name="disposing" Type="System.Boolean" />
 148       </Parameters>
 149       <Docs>
 150         <remarks>To be added.</remarks>
 151         <summary>
 152           <attribution license="cc4" from="Microsoft" modified="false" />
 153           <para>Releases the unmanaged resources used by the <see cref="T:System.ComponentModel.Composition.Hosting.CatalogExportProvider" /> and optionally releases the managed resources. </para>
 154         </summary>
 155         <param name="disposing">
 156           <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param>
 157       </Docs>
 158     </Member>
 159     <Member MemberName="GetExportsCore">
 160       <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);" />
 161       <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" />
 162       <MemberType>Method</MemberType>
 163       <AssemblyInfo>
 164         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 165       </AssemblyInfo>
 166       <ReturnValue>
 167         <ReturnType>System.Collections.Generic.IEnumerable&lt;System.ComponentModel.Composition.Primitives.Export&gt;</ReturnType>
 168       </ReturnValue>
 169       <Parameters>
 170         <Parameter Name="definition" Type="System.ComponentModel.Composition.Primitives.ImportDefinition" />
 171         <Parameter Name="atomicComposition" Type="System.ComponentModel.Composition.Hosting.AtomicComposition" />
 172       </Parameters>
 173       <Docs>
 174         <remarks>
 175           <attribution license="cc4" from="Microsoft" modified="false" />
 176           <para>Implementers should not treat cardinality-related mismatches as errors and should not throw exceptions for cardinality-related mismatches. For example, if the import requests exactly one export and the provider has either no matching exports or more than one, the <see cref="M:System.ComponentModel.Composition.Hosting.CatalogExportProvider.GetExportsCore(System.ComponentModel.Composition.Primitives.ImportDefinition,System.ComponentModel.Composition.Hosting.AtomicComposition)" /> method should return an empty <see cref="T:System.Collections.Generic.IEnumerable`1" /> collection of <see cref="T:System.ComponentModel.Composition.Primitives.Export" /> objects.</para>
 177         </remarks>
 178         <summary>
 179           <attribution license="cc4" from="Microsoft" modified="false" />
 180           <para>Returns all exports that match the conditions of the specified import.</para>
 181         </summary>
 182         <returns>
 183           <attribution license="cc4" from="Microsoft" modified="false" />
 184           <para>A collection that contains all the exports that match the specified condition.</para>
 185         </returns>
 186         <param name="definition">
 187           <attribution license="cc4" from="Microsoft" modified="false" />The conditions of the <see cref="T:System.ComponentModel.Composition.Primitives.Export" /> objects to be returned.</param>
 188         <param name="atomicComposition">
 189           <attribution license="cc4" from="Microsoft" modified="false" />The composition transaction to use, or null to disable transactional composition.</param>
 190       </Docs>
 191     </Member>
 192     <Member MemberName="SourceProvider">
 193       <MemberSignature Language="C#" Value="public System.ComponentModel.Composition.Hosting.ExportProvider SourceProvider { get; set; }" />
 194       <MemberSignature Language="ILAsm" Value=".property instance class System.ComponentModel.Composition.Hosting.ExportProvider SourceProvider" />
 195       <MemberType>Property</MemberType>
 196       <AssemblyInfo>
 197         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 198       </AssemblyInfo>
 199       <ReturnValue>
 200         <ReturnType>System.ComponentModel.Composition.Hosting.ExportProvider</ReturnType>
 201       </ReturnValue>
 202       <Docs>
 203         <value>To be added.</value>
 204         <remarks>
 205           <attribution license="cc4" from="Microsoft" modified="false" />
 206           <para>You must set this property before you access any methods on the <see cref="T:System.ComponentModel.Composition.Hosting.CatalogExportProvider" /> object.</para>
 207         </remarks>
 208         <summary>
 209           <attribution license="cc4" from="Microsoft" modified="false" />
 210           <para>Gets or sets the export provider that provides access to additional exports.</para>
 211         </summary>
 212       </Docs>
 213     </Member>
 214   </Members>
 215 </Type>