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

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="ComposablePart" FullName="System.ComponentModel.Composition.Primitives.ComposablePart">
   3   <TypeSignature Language="C#" Value="public abstract class ComposablePart" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ComposablePart extends System.Object" />
   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   <Docs>
  14     <remarks>To be added.</remarks>
  15     <summary>
  16       <attribution license="cc4" from="Microsoft" modified="false" />
  17       <para>Defines the abstract base class for composable parts, which import objects and produce exported objects.</para>
  18     </summary>
  19   </Docs>
  20   <Members>
  21     <Member MemberName=".ctor">
  22       <MemberSignature Language="C#" Value="protected ComposablePart ();" />
  23       <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
  24       <MemberType>Constructor</MemberType>
  25       <AssemblyInfo>
  26         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  27       </AssemblyInfo>
  28       <Parameters />
  29       <Docs>
  30         <remarks>To be added.</remarks>
  31         <summary>
  32           <attribution license="cc4" from="Microsoft" modified="false" />
  33           <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePart" /> class.</para>
  34         </summary>
  35       </Docs>
  36     </Member>
  37     <Member MemberName="Activate">
  38       <MemberSignature Language="C#" Value="public virtual void Activate ();" />
  39       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Activate() cil managed" />
  40       <MemberType>Method</MemberType>
  41       <AssemblyInfo>
  42         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  43       </AssemblyInfo>
  44       <ReturnValue>
  45         <ReturnType>System.Void</ReturnType>
  46       </ReturnValue>
  47       <Parameters />
  48       <Docs>
  49         <remarks>
  50           <attribution license="cc4" from="Microsoft" modified="false" />
  51           <para>Once this method is called, no further imports can be set unless a call is made to Deactivate.</para>
  52         </remarks>
  53         <summary>
  54           <attribution license="cc4" from="Microsoft" modified="false" />
  55           <para>Called when all the imports of the part have been set, and exports can be retrieved.</para>
  56         </summary>
  57       </Docs>
  58     </Member>
  59     <Member MemberName="ExportDefinitions">
  60       <MemberSignature Language="C#" Value="public abstract System.Collections.Generic.IEnumerable&lt;System.ComponentModel.Composition.Primitives.ExportDefinition&gt; ExportDefinitions { get; }" />
  61       <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1&lt;class System.ComponentModel.Composition.Primitives.ExportDefinition&gt; ExportDefinitions" />
  62       <MemberType>Property</MemberType>
  63       <AssemblyInfo>
  64         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  65       </AssemblyInfo>
  66       <ReturnValue>
  67         <ReturnType>System.Collections.Generic.IEnumerable&lt;System.ComponentModel.Composition.Primitives.ExportDefinition&gt;</ReturnType>
  68       </ReturnValue>
  69       <Docs>
  70         <value>To be added.</value>
  71         <remarks>
  72           <attribution license="cc4" from="Microsoft" modified="false" />
  73           <para>If the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePart" /> object was created from a <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartDefinition" /> object, this property should return the result of <see cref="P:System.ComponentModel.Composition.Primitives.ComposablePartDefinition.ExportDefinitions" />.</para>
  74           <para>Overrides of this property should never return null. If the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePart" /> does not have exports, return an empty <see cref="T:System.Collections.Generic.IEnumerable`1" /> collection instead.</para>
  75         </remarks>
  76         <summary>
  77           <attribution license="cc4" from="Microsoft" modified="false" />
  78           <para>Gets a collection of the <see cref="T:System.ComponentModel.Composition.Primitives.ExportDefinition" /> objects that describe the exported objects provided by the part.</para>
  79         </summary>
  80       </Docs>
  81     </Member>
  82     <Member MemberName="GetExportedValue">
  83       <MemberSignature Language="C#" Value="public abstract object GetExportedValue (System.ComponentModel.Composition.Primitives.ExportDefinition definition);" />
  84       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance object GetExportedValue(class System.ComponentModel.Composition.Primitives.ExportDefinition definition) cil managed" />
  85       <MemberType>Method</MemberType>
  86       <AssemblyInfo>
  87         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  88       </AssemblyInfo>
  89       <ReturnValue>
  90         <ReturnType>System.Object</ReturnType>
  91       </ReturnValue>
  92       <Parameters>
  93         <Parameter Name="definition" Type="System.ComponentModel.Composition.Primitives.ExportDefinition" />
  94       </Parameters>
  95       <Docs>
  96         <remarks>To be added.</remarks>
  97         <summary>
  98           <attribution license="cc4" from="Microsoft" modified="false" />
  99           <para>Gets the exported object described by the specified <see cref="T:System.ComponentModel.Composition.Primitives.ExportDefinition" /> object.</para>
 100         </summary>
 101         <returns>
 102           <attribution license="cc4" from="Microsoft" modified="false" />
 103           <para>The exported object described by <paramref name="definition" />.</para>
 104         </returns>
 105         <param name="definition">
 106           <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.ComponentModel.Composition.Primitives.ExportDefinition" /> objects from the <see cref="P:System.ComponentModel.Composition.Primitives.ComposablePart.ExportDefinitions" /> property that describes the exported object to return.</param>
 107       </Docs>
 108     </Member>
 109     <Member MemberName="ImportDefinitions">
 110       <MemberSignature Language="C#" Value="public abstract System.Collections.Generic.IEnumerable&lt;System.ComponentModel.Composition.Primitives.ImportDefinition&gt; ImportDefinitions { get; }" />
 111       <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1&lt;class System.ComponentModel.Composition.Primitives.ImportDefinition&gt; ImportDefinitions" />
 112       <MemberType>Property</MemberType>
 113       <AssemblyInfo>
 114         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 115       </AssemblyInfo>
 116       <ReturnValue>
 117         <ReturnType>System.Collections.Generic.IEnumerable&lt;System.ComponentModel.Composition.Primitives.ImportDefinition&gt;</ReturnType>
 118       </ReturnValue>
 119       <Docs>
 120         <value>To be added.</value>
 121         <remarks>
 122           <attribution license="cc4" from="Microsoft" modified="false" />
 123           <para>If the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePart" /> object was created from a <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartDefinition" /> object, this property should return the result of <see cref="P:System.ComponentModel.Composition.Primitives.ComposablePartDefinition.ImportDefinitions" />.</para>
 124           <para>Overrides of this property should never return null. If the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePart" /> does not have imports, return an empty <see cref="T:System.Collections.Generic.IEnumerable`1" /> collection instead.</para>
 125         </remarks>
 126         <summary>
 127           <attribution license="cc4" from="Microsoft" modified="false" />
 128           <para>Gets a collection of the <see cref="T:System.ComponentModel.Composition.Primitives.ImportDefinition" /> objects that describe the imported objects required by the part.</para>
 129         </summary>
 130       </Docs>
 131     </Member>
 132     <Member MemberName="Metadata">
 133       <MemberSignature Language="C#" Value="public virtual System.Collections.Generic.IDictionary&lt;string,object&gt; Metadata { get; }" />
 134       <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2&lt;string, object&gt; Metadata" />
 135       <MemberType>Property</MemberType>
 136       <AssemblyInfo>
 137         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 138       </AssemblyInfo>
 139       <ReturnValue>
 140         <ReturnType>System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;</ReturnType>
 141       </ReturnValue>
 142       <Docs>
 143         <value>To be added.</value>
 144         <remarks>
 145           <attribution license="cc4" from="Microsoft" modified="false" />
 146           <para>If the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePart" /> object was created from a <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartDefinition" /> object, this property should return the result of <see cref="P:System.ComponentModel.Composition.Primitives.ComposablePartDefinition.Metadata" />.</para>
 147           <para>Overrides of this property should return a read-only <see cref="T:System.Collections.Generic.IDictionary`2" /> object with a case-sensitive, non-linguistic comparer, such as <see cref="P:System.StringComparer.Ordinal" />, and should never return null. If the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePart" /> does not contain metadata, return an empty <see cref="T:System.Collections.Generic.IDictionary`2" /> instead.</para>
 148         </remarks>
 149         <summary>
 150           <attribution license="cc4" from="Microsoft" modified="false" />
 151           <para>Gets the metadata of the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePart" /> object.</para>
 152         </summary>
 153       </Docs>
 154     </Member>
 155     <Member MemberName="SetImport">
 156       <MemberSignature Language="C#" Value="public abstract void SetImport (System.ComponentModel.Composition.Primitives.ImportDefinition definition, System.Collections.Generic.IEnumerable&lt;System.ComponentModel.Composition.Primitives.Export&gt; exports);" />
 157       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetImport(class System.ComponentModel.Composition.Primitives.ImportDefinition definition, class System.Collections.Generic.IEnumerable`1&lt;class System.ComponentModel.Composition.Primitives.Export&gt; exports) cil managed" />
 158       <MemberType>Method</MemberType>
 159       <AssemblyInfo>
 160         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 161       </AssemblyInfo>
 162       <ReturnValue>
 163         <ReturnType>System.Void</ReturnType>
 164       </ReturnValue>
 165       <Parameters>
 166         <Parameter Name="definition" Type="System.ComponentModel.Composition.Primitives.ImportDefinition" />
 167         <Parameter Name="exports" Type="System.Collections.Generic.IEnumerable&lt;System.ComponentModel.Composition.Primitives.Export&gt;" />
 168       </Parameters>
 169       <Docs>
 170         <remarks>To be added.</remarks>
 171         <summary>
 172           <attribution license="cc4" from="Microsoft" modified="false" />
 173           <para>Sets the import described by the specified <see cref="T:System.ComponentModel.Composition.Primitives.ImportDefinition" /> object to be satisfied by the specified exports.</para>
 174         </summary>
 175         <param name="definition">
 176           <attribution license="cc4" from="Microsoft" modified="false" />One of the objects from the <see cref="P:System.ComponentModel.Composition.Primitives.ComposablePart.ImportDefinitions" /> property that specifies the import to be set.</param>
 177         <param name="exports">
 178           <attribution license="cc4" from="Microsoft" modified="false" />A collection of <see cref="T:System.ComponentModel.Composition.Primitives.Export" /> objects of which to set the import described by <paramref name="definition" />.</param>
 179       </Docs>
 180     </Member>
 181   </Members>
 182 </Type>