mcs/class/System.ComponentModel.Composition/Documentation/en/System.ComponentModel.Composition.Primitives/ComposablePartCatalog.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="ComposablePartCatalog" FullName="System.ComponentModel.Composition.Primitives.ComposablePartCatalog">
   3   <TypeSignature Language="C#" Value="public abstract class ComposablePartCatalog : IDisposable, System.Collections.Generic.IEnumerable&lt;System.ComponentModel.Composition.Primitives.ComposablePartDefinition&gt;" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ComposablePartCatalog extends System.Object implements class System.Collections.Generic.IEnumerable`1&lt;class System.ComponentModel.Composition.Primitives.ComposablePartDefinition&gt;, class System.Collections.IEnumerable, 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.Object</BaseTypeName>
  11   </Base>
  12   <Interfaces>
  13     <Interface>
  14       <InterfaceName>System.Collections.Generic.IEnumerable&lt;System.ComponentModel.Composition.Primitives.ComposablePartDefinition&gt;</InterfaceName>
  15     </Interface>
  16     <Interface>
  17       <InterfaceName>System.IDisposable</InterfaceName>
  18     </Interface>
  19   </Interfaces>
  20   <Attributes>
  21     <Attribute>
  22       <AttributeName>System.Diagnostics.DebuggerTypeProxy(typeof(System.ComponentModel.Composition.Primitives.ComposablePartCatalogDebuggerProxy))</AttributeName>
  23     </Attribute>
  24   </Attributes>
  25   <Docs>
  26     <remarks>
  27       <attribution license="cc4" from="Microsoft" modified="false" />
  28       <para>This type is thread safe.</para>
  29     </remarks>
  30     <summary>
  31       <attribution license="cc4" from="Microsoft" modified="false" />
  32       <para>Represents the abstract base class for composable part catalogs, which collect and return <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartDefinition" /> objects.</para>
  33     </summary>
  34   </Docs>
  35   <Members>
  36     <Member MemberName=".ctor">
  37       <MemberSignature Language="C#" Value="protected ComposablePartCatalog ();" />
  38       <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
  39       <MemberType>Constructor</MemberType>
  40       <AssemblyInfo>
  41         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  42       </AssemblyInfo>
  43       <Parameters />
  44       <Docs>
  45         <remarks>To be added.</remarks>
  46         <summary>
  47           <attribution license="cc4" from="Microsoft" modified="false" />
  48           <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" /> class.</para>
  49         </summary>
  50       </Docs>
  51     </Member>
  52     <Member MemberName="Dispose">
  53       <MemberSignature Language="C#" Value="public void Dispose ();" />
  54       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
  55       <MemberType>Method</MemberType>
  56       <AssemblyInfo>
  57         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  58       </AssemblyInfo>
  59       <ReturnValue>
  60         <ReturnType>System.Void</ReturnType>
  61       </ReturnValue>
  62       <Parameters />
  63       <Docs>
  64         <remarks>
  65           <attribution license="cc4" from="Microsoft" modified="false" />
  66           <para>Call Dispose when you are finished using the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" />. The Dispose method leaves the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" /> in an unusable state. After calling Dispose, you must release all references to the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" /> so the garbage collector can reclaim the memory that the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" /> was occupying.</para>
  67           <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>
  68           <block subset="none" type="note">
  69             <para>Always call Dispose before you release your last reference to the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" /> object's Finalize method.</para>
  70           </block>
  71         </remarks>
  72         <summary>
  73           <attribution license="cc4" from="Microsoft" modified="false" />
  74           <para>Releases all resources used by the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" />.</para>
  75         </summary>
  76       </Docs>
  77     </Member>
  78     <Member MemberName="Dispose">
  79       <MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
  80       <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
  81       <MemberType>Method</MemberType>
  82       <AssemblyInfo>
  83         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  84       </AssemblyInfo>
  85       <ReturnValue>
  86         <ReturnType>System.Void</ReturnType>
  87       </ReturnValue>
  88       <Parameters>
  89         <Parameter Name="disposing" Type="System.Boolean" />
  90       </Parameters>
  91       <Docs>
  92         <remarks>To be added.</remarks>
  93         <summary>
  94           <attribution license="cc4" from="Microsoft" modified="false" />
  95           <para>Releases the unmanaged resources used by the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" /> and optionally releases the managed resources. </para>
  96         </summary>
  97         <param name="disposing">
  98           <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param>
  99       </Docs>
 100     </Member>
 101     <Member MemberName="GetEnumerator">
 102       <MemberSignature Language="C#" Value="public virtual System.Collections.Generic.IEnumerator&lt;System.ComponentModel.Composition.Primitives.ComposablePartDefinition&gt; GetEnumerator ();" />
 103       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IEnumerator`1&lt;class System.ComponentModel.Composition.Primitives.ComposablePartDefinition&gt; GetEnumerator() cil managed" />
 104       <MemberType>Method</MemberType>
 105       <AssemblyInfo>
 106         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 107       </AssemblyInfo>
 108       <ReturnValue>
 109         <ReturnType>System.Collections.Generic.IEnumerator&lt;System.ComponentModel.Composition.Primitives.ComposablePartDefinition&gt;</ReturnType>
 110       </ReturnValue>
 111       <Parameters />
 112       <Docs>
 113         <remarks>To be added.</remarks>
 114         <summary>
 115           <attribution license="cc4" from="Microsoft" modified="false" />
 116           <para>Returns an enumerator that iterates through the catalog.</para>
 117         </summary>
 118         <returns>
 119           <attribution license="cc4" from="Microsoft" modified="false" />
 120           <para>An enumerator that can be used to iterate through the catalog.</para>
 121         </returns>
 122       </Docs>
 123     </Member>
 124     <Member MemberName="GetExports">
 125       <MemberSignature Language="C#" Value="public virtual System.Collections.Generic.IEnumerable&lt;Tuple&lt;System.ComponentModel.Composition.Primitives.ComposablePartDefinition,System.ComponentModel.Composition.Primitives.ExportDefinition&gt;&gt; GetExports (System.ComponentModel.Composition.Primitives.ImportDefinition definition);" />
 126       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IEnumerable`1&lt;class System.Tuple`2&lt;class System.ComponentModel.Composition.Primitives.ComposablePartDefinition, class System.ComponentModel.Composition.Primitives.ExportDefinition&gt;&gt; GetExports(class System.ComponentModel.Composition.Primitives.ImportDefinition definition) cil managed" />
 127       <MemberType>Method</MemberType>
 128       <AssemblyInfo>
 129         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 130       </AssemblyInfo>
 131       <ReturnValue>
 132         <ReturnType>System.Collections.Generic.IEnumerable&lt;System.Tuple&lt;System.ComponentModel.Composition.Primitives.ComposablePartDefinition,System.ComponentModel.Composition.Primitives.ExportDefinition&gt;&gt;</ReturnType>
 133       </ReturnValue>
 134       <Parameters>
 135         <Parameter Name="definition" Type="System.ComponentModel.Composition.Primitives.ImportDefinition" />
 136       </Parameters>
 137       <Docs>
 138         <remarks>
 139           <attribution license="cc4" from="Microsoft" modified="false" />
 140           <para>Overrides of this method should never return null. If no <see cref="T:System.ComponentModel.Composition.Primitives.ExportDefinition" /> matches the conditions defined by <paramref name="definition" />, return an empty <see cref="T:System.Collections.Generic.IEnumerable`1" /> object.</para>
 141         </remarks>
 142         <summary>
 143           <attribution license="cc4" from="Microsoft" modified="false" />
 144           <para>Gets a list of export definitions that match the constraint defined by the specified <see cref="T:System.ComponentModel.Composition.Primitives.ImportDefinition" /> object.</para>
 145         </summary>
 146         <returns>
 147           <attribution license="cc4" from="Microsoft" modified="false" />
 148           <para>A collection of <see cref="T:System.Tuple`2" /> containing the <see cref="T:System.ComponentModel.Composition.Primitives.ExportDefinition" /> objects and their associated <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartDefinition" /> objects for objects that match the constraint specified by <paramref name="definition" />.</para>
 149         </returns>
 150         <param name="definition">
 151           <attribution license="cc4" from="Microsoft" modified="false" />The conditions of the <see cref="T:System.ComponentModel.Composition.Primitives.ExportDefinition" /> objects to be returned.</param>
 152       </Docs>
 153     </Member>
 154     <Member MemberName="Parts">
 155       <MemberSignature Language="C#" Value="public virtual System.Linq.IQueryable&lt;System.ComponentModel.Composition.Primitives.ComposablePartDefinition&gt; Parts { get; }" />
 156       <MemberSignature Language="ILAsm" Value=".property instance class System.Linq.IQueryable`1&lt;class System.ComponentModel.Composition.Primitives.ComposablePartDefinition&gt; Parts" />
 157       <MemberType>Property</MemberType>
 158       <AssemblyInfo>
 159         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 160       </AssemblyInfo>
 161       <Attributes>
 162         <Attribute>
 163           <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
 164         </Attribute>
 165       </Attributes>
 166       <ReturnValue>
 167         <ReturnType>System.Linq.IQueryable&lt;System.ComponentModel.Composition.Primitives.ComposablePartDefinition&gt;</ReturnType>
 168       </ReturnValue>
 169       <Docs>
 170         <value>To be added.</value>
 171         <remarks>
 172           <attribution license="cc4" from="Microsoft" modified="false" />
 173           <para>Overrides of this property should never return null.</para>
 174         </remarks>
 175         <summary>
 176           <attribution license="cc4" from="Microsoft" modified="false" />
 177           <para>Gets the part definitions that are contained in the catalog.</para>
 178         </summary>
 179       </Docs>
 180     </Member>
 181     <Member MemberName="System.Collections.IEnumerable.GetEnumerator">
 182       <MemberSignature Language="C#" Value="System.Collections.IEnumerator IEnumerable.GetEnumerator ();" />
 183       <MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() cil managed" />
 184       <MemberType>Method</MemberType>
 185       <AssemblyInfo>
 186         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 187       </AssemblyInfo>
 188       <ReturnValue>
 189         <ReturnType>System.Collections.IEnumerator</ReturnType>
 190       </ReturnValue>
 191       <Parameters />
 192       <Docs>
 193         <remarks>
 194           <attribution license="cc4" from="Microsoft" modified="false" />
 195           <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" /> instance is cast to an <see cref="T:System.Collections.IEnumerable" /> interface.</para>
 196         </remarks>
 197         <summary>
 198           <attribution license="cc4" from="Microsoft" modified="false" />
 199           <para>Returns an enumerator that iterates through the catalog.</para>
 200         </summary>
 201         <returns>
 202           <attribution license="cc4" from="Microsoft" modified="false" />
 203           <para>An enumerator that can be used to iterate through the catalog.</para>
 204         </returns>
 205       </Docs>
 206     </Member>
 207   </Members>
 208 </Type>