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

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="AggregateCatalog" FullName="System.ComponentModel.Composition.Hosting.AggregateCatalog">
   3   <TypeSignature Language="C#" Value="public class AggregateCatalog : System.ComponentModel.Composition.Primitives.ComposablePartCatalog, System.ComponentModel.Composition.Hosting.INotifyComposablePartCatalogChanged" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AggregateCatalog extends System.ComponentModel.Composition.Primitives.ComposablePartCatalog implements class System.ComponentModel.Composition.Hosting.INotifyComposablePartCatalogChanged" />
   5   <AssemblyInfo>
   6     <AssemblyName>System.ComponentModel.Composition</AssemblyName>
   7     <AssemblyVersion>4.0.0.0</AssemblyVersion>
   8   </AssemblyInfo>
   9   <Base>
  10     <BaseTypeName>System.ComponentModel.Composition.Primitives.ComposablePartCatalog</BaseTypeName>
  11   </Base>
  12   <Interfaces>
  13     <Interface>
  14       <InterfaceName>System.ComponentModel.Composition.Hosting.INotifyComposablePartCatalogChanged</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>A catalog that combines the elements of <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" /> objects. </para>
  22     </summary>
  23   </Docs>
  24   <Members>
  25     <Member MemberName=".ctor">
  26       <MemberSignature Language="C#" Value="public AggregateCatalog ();" />
  27       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  28       <MemberType>Constructor</MemberType>
  29       <AssemblyInfo>
  30         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  31       </AssemblyInfo>
  32       <Parameters />
  33       <Docs>
  34         <remarks>To be added.</remarks>
  35         <summary>
  36           <attribution license="cc4" from="Microsoft" modified="false" />
  37           <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateCatalog" /> class.</para>
  38         </summary>
  39       </Docs>
  40     </Member>
  41     <Member MemberName=".ctor">
  42       <MemberSignature Language="C#" Value="public AggregateCatalog (System.Collections.Generic.IEnumerable&lt;System.ComponentModel.Composition.Primitives.ComposablePartCatalog&gt; catalogs);" />
  43       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IEnumerable`1&lt;class System.ComponentModel.Composition.Primitives.ComposablePartCatalog&gt; catalogs) cil managed" />
  44       <MemberType>Constructor</MemberType>
  45       <AssemblyInfo>
  46         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  47       </AssemblyInfo>
  48       <Parameters>
  49         <Parameter Name="catalogs" Type="System.Collections.Generic.IEnumerable&lt;System.ComponentModel.Composition.Primitives.ComposablePartCatalog&gt;" />
  50       </Parameters>
  51       <Docs>
  52         <remarks>To be added.</remarks>
  53         <summary>
  54           <attribution license="cc4" from="Microsoft" modified="false" />
  55           <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateCatalog" /> class with the specified catalogs.</para>
  56         </summary>
  57         <param name="catalogs">
  58           <attribution license="cc4" from="Microsoft" modified="false" />A collection of <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" /> objects to add to the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateCatalog" /> or null to create an empty <see cref="T:System.ComponentModel.Composition.Hosting.AggregateCatalog" />. </param>
  59       </Docs>
  60     </Member>
  61     <Member MemberName=".ctor">
  62       <MemberSignature Language="C#" Value="public AggregateCatalog (System.ComponentModel.Composition.Primitives.ComposablePartCatalog[] catalogs);" />
  63       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.ComponentModel.Composition.Primitives.ComposablePartCatalog[] catalogs) cil managed" />
  64       <MemberType>Constructor</MemberType>
  65       <AssemblyInfo>
  66         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  67       </AssemblyInfo>
  68       <Parameters>
  69         <Parameter Name="catalogs" Type="System.ComponentModel.Composition.Primitives.ComposablePartCatalog[]">
  70           <Attributes>
  71             <Attribute>
  72               <AttributeName>System.ParamArray</AttributeName>
  73             </Attribute>
  74           </Attributes>
  75         </Parameter>
  76       </Parameters>
  77       <Docs>
  78         <remarks>To be added.</remarks>
  79         <summary>
  80           <attribution license="cc4" from="Microsoft" modified="false" />
  81           <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateCatalog" /> class with the specified catalogs.</para>
  82         </summary>
  83         <param name="catalogs">
  84           <attribution license="cc4" from="Microsoft" modified="false" />A array of <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" /> objects to add to the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateCatalog" />.</param>
  85       </Docs>
  86     </Member>
  87     <Member MemberName="Catalogs">
  88       <MemberSignature Language="C#" Value="public System.Collections.Generic.ICollection&lt;System.ComponentModel.Composition.Primitives.ComposablePartCatalog&gt; Catalogs { get; }" />
  89       <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.ICollection`1&lt;class System.ComponentModel.Composition.Primitives.ComposablePartCatalog&gt; Catalogs" />
  90       <MemberType>Property</MemberType>
  91       <AssemblyInfo>
  92         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  93       </AssemblyInfo>
  94       <ReturnValue>
  95         <ReturnType>System.Collections.Generic.ICollection&lt;System.ComponentModel.Composition.Primitives.ComposablePartCatalog&gt;</ReturnType>
  96       </ReturnValue>
  97       <Docs>
  98         <value>To be added.</value>
  99         <remarks>To be added.</remarks>
 100         <summary>
 101           <attribution license="cc4" from="Microsoft" modified="false" />
 102           <para>Gets the underlying catalogs of the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateCatalog" /> object.</para>
 103         </summary>
 104       </Docs>
 105     </Member>
 106     <Member MemberName="Changed">
 107       <MemberSignature Language="C#" Value="public event EventHandler&lt;System.ComponentModel.Composition.Hosting.ComposablePartCatalogChangeEventArgs&gt; Changed;" />
 108       <MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1&lt;class System.ComponentModel.Composition.Hosting.ComposablePartCatalogChangeEventArgs&gt; Changed" />
 109       <MemberType>Event</MemberType>
 110       <AssemblyInfo>
 111         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 112       </AssemblyInfo>
 113       <ReturnValue>
 114         <ReturnType>System.EventHandler&lt;System.ComponentModel.Composition.Hosting.ComposablePartCatalogChangeEventArgs&gt;</ReturnType>
 115       </ReturnValue>
 116       <Docs>
 117         <remarks>To be added.</remarks>
 118         <summary>
 119           <attribution license="cc4" from="Microsoft" modified="false" />
 120           <para>Occurs when the contents of the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateCatalog" /> object have changed.</para>
 121         </summary>
 122       </Docs>
 123     </Member>
 124     <Member MemberName="Changing">
 125       <MemberSignature Language="C#" Value="public event EventHandler&lt;System.ComponentModel.Composition.Hosting.ComposablePartCatalogChangeEventArgs&gt; Changing;" />
 126       <MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1&lt;class System.ComponentModel.Composition.Hosting.ComposablePartCatalogChangeEventArgs&gt; Changing" />
 127       <MemberType>Event</MemberType>
 128       <AssemblyInfo>
 129         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 130       </AssemblyInfo>
 131       <ReturnValue>
 132         <ReturnType>System.EventHandler&lt;System.ComponentModel.Composition.Hosting.ComposablePartCatalogChangeEventArgs&gt;</ReturnType>
 133       </ReturnValue>
 134       <Docs>
 135         <remarks>To be added.</remarks>
 136         <summary>
 137           <attribution license="cc4" from="Microsoft" modified="false" />
 138           <para>Occurs when the contents of the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateCatalog" /> object are changing.</para>
 139         </summary>
 140       </Docs>
 141     </Member>
 142     <Member MemberName="Dispose">
 143       <MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
 144       <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Dispose(bool disposing) cil managed" />
 145       <MemberType>Method</MemberType>
 146       <AssemblyInfo>
 147         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 148       </AssemblyInfo>
 149       <ReturnValue>
 150         <ReturnType>System.Void</ReturnType>
 151       </ReturnValue>
 152       <Parameters>
 153         <Parameter Name="disposing" Type="System.Boolean" />
 154       </Parameters>
 155       <Docs>
 156         <remarks>To be added.</remarks>
 157         <summary>
 158           <attribution license="cc4" from="Microsoft" modified="false" />
 159           <para>Releases the unmanaged resources used by the <see cref="T:System.ComponentModel.Composition.Hosting.AggregateCatalog" /> and optionally releases the managed resources. </para>
 160         </summary>
 161         <param name="disposing">
 162           <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param>
 163       </Docs>
 164     </Member>
 165     <Member MemberName="GetEnumerator">
 166       <MemberSignature Language="C#" Value="public override System.Collections.Generic.IEnumerator&lt;System.ComponentModel.Composition.Primitives.ComposablePartDefinition&gt; GetEnumerator ();" />
 167       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Collections.Generic.IEnumerator`1&lt;class System.ComponentModel.Composition.Primitives.ComposablePartDefinition&gt; GetEnumerator() cil managed" />
 168       <MemberType>Method</MemberType>
 169       <AssemblyInfo>
 170         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 171       </AssemblyInfo>
 172       <ReturnValue>
 173         <ReturnType>System.Collections.Generic.IEnumerator&lt;System.ComponentModel.Composition.Primitives.ComposablePartDefinition&gt;</ReturnType>
 174       </ReturnValue>
 175       <Parameters />
 176       <Docs>
 177         <remarks>To be added.</remarks>
 178         <summary>
 179           <attribution license="cc4" from="Microsoft" modified="false" />
 180           <para>Returns an enumerator that iterates through the catalog.</para>
 181         </summary>
 182         <returns>
 183           <attribution license="cc4" from="Microsoft" modified="false" />
 184           <para>An enumerator that can be used to iterate through the catalog.</para>
 185         </returns>
 186       </Docs>
 187     </Member>
 188     <Member MemberName="GetExports">
 189       <MemberSignature Language="C#" Value="public override 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);" />
 190       <MemberSignature Language="ILAsm" Value=".method public hidebysig 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" />
 191       <MemberType>Method</MemberType>
 192       <AssemblyInfo>
 193         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 194       </AssemblyInfo>
 195       <ReturnValue>
 196         <ReturnType>System.Collections.Generic.IEnumerable&lt;System.Tuple&lt;System.ComponentModel.Composition.Primitives.ComposablePartDefinition,System.ComponentModel.Composition.Primitives.ExportDefinition&gt;&gt;</ReturnType>
 197       </ReturnValue>
 198       <Parameters>
 199         <Parameter Name="definition" Type="System.ComponentModel.Composition.Primitives.ImportDefinition" />
 200       </Parameters>
 201       <Docs>
 202         <remarks>To be added.</remarks>
 203         <summary>
 204           <attribution license="cc4" from="Microsoft" modified="false" />
 205           <para>Gets the export definitions that match the constraint expressed by the specified definition.</para>
 206         </summary>
 207         <returns>
 208           <attribution license="cc4" from="Microsoft" modified="false" />
 209           <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>
 210         </returns>
 211         <param name="definition">
 212           <attribution license="cc4" from="Microsoft" modified="false" />The conditions of the <see cref="T:System.ComponentModel.Composition.Primitives.ExportDefinition" /> objects to be returned.</param>
 213       </Docs>
 214     </Member>
 215     <Member MemberName="OnChanged">
 216       <MemberSignature Language="C#" Value="protected virtual void OnChanged (System.ComponentModel.Composition.Hosting.ComposablePartCatalogChangeEventArgs e);" />
 217       <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnChanged(class System.ComponentModel.Composition.Hosting.ComposablePartCatalogChangeEventArgs e) cil managed" />
 218       <MemberType>Method</MemberType>
 219       <AssemblyInfo>
 220         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 221       </AssemblyInfo>
 222       <ReturnValue>
 223         <ReturnType>System.Void</ReturnType>
 224       </ReturnValue>
 225       <Parameters>
 226         <Parameter Name="e" Type="System.ComponentModel.Composition.Hosting.ComposablePartCatalogChangeEventArgs" />
 227       </Parameters>
 228       <Docs>
 229         <remarks>To be added.</remarks>
 230         <summary>
 231           <attribution license="cc4" from="Microsoft" modified="false" />
 232           <para>Raises the <see cref="E:System.ComponentModel.Composition.Hosting.AggregateCatalog.Changed" /> event.</para>
 233         </summary>
 234         <param name="e">
 235           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Composition.Hosting.ComposablePartCatalogChangeEventArgs" /> object that contains the event data. </param>
 236       </Docs>
 237     </Member>
 238     <Member MemberName="OnChanging">
 239       <MemberSignature Language="C#" Value="protected virtual void OnChanging (System.ComponentModel.Composition.Hosting.ComposablePartCatalogChangeEventArgs e);" />
 240       <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnChanging(class System.ComponentModel.Composition.Hosting.ComposablePartCatalogChangeEventArgs e) cil managed" />
 241       <MemberType>Method</MemberType>
 242       <AssemblyInfo>
 243         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 244       </AssemblyInfo>
 245       <ReturnValue>
 246         <ReturnType>System.Void</ReturnType>
 247       </ReturnValue>
 248       <Parameters>
 249         <Parameter Name="e" Type="System.ComponentModel.Composition.Hosting.ComposablePartCatalogChangeEventArgs" />
 250       </Parameters>
 251       <Docs>
 252         <remarks>To be added.</remarks>
 253         <summary>
 254           <attribution license="cc4" from="Microsoft" modified="false" />
 255           <para>Raises the <see cref="E:System.ComponentModel.Composition.Hosting.AggregateCatalog.Changing" /> event.</para>
 256         </summary>
 257         <param name="e">
 258           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Composition.Hosting.ComposablePartCatalogChangeEventArgs" /> object that contains the event data. </param>
 259       </Docs>
 260     </Member>
 261   </Members>
 262 </Type>