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

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="ComposablePartDefinition" FullName="System.ComponentModel.Composition.Primitives.ComposablePartDefinition">
   3   <TypeSignature Language="C#" Value="public abstract class ComposablePartDefinition" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ComposablePartDefinition 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 an abstract base class for composable part definitions, which describe and enable the creation of <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePart" /> objects.</para>
  18     </summary>
  19   </Docs>
  20   <Members>
  21     <Member MemberName=".ctor">
  22       <MemberSignature Language="C#" Value="protected ComposablePartDefinition ();" />
  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.ComposablePartDefinition" /> class.</para>
  34         </summary>
  35       </Docs>
  36     </Member>
  37     <Member MemberName="CreatePart">
  38       <MemberSignature Language="C#" Value="public abstract System.ComponentModel.Composition.Primitives.ComposablePart CreatePart ();" />
  39       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.ComponentModel.Composition.Primitives.ComposablePart CreatePart() cil managed" />
  40       <MemberType>Method</MemberType>
  41       <AssemblyInfo>
  42         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  43       </AssemblyInfo>
  44       <ReturnValue>
  45         <ReturnType>System.ComponentModel.Composition.Primitives.ComposablePart</ReturnType>
  46       </ReturnValue>
  47       <Parameters />
  48       <Docs>
  49         <remarks>
  50           <attribution license="cc4" from="Microsoft" modified="false" />
  51           <para>Derived types that override this method should return a new instance of a <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePart" /> object every time that the method is invoked and should never return null.</para>
  52         </remarks>
  53         <summary>
  54           <attribution license="cc4" from="Microsoft" modified="false" />
  55           <para>Creates a new instance of a part that the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartDefinition" /> describes.</para>
  56         </summary>
  57         <returns>
  58           <attribution license="cc4" from="Microsoft" modified="false" />
  59           <para>The created part.</para>
  60         </returns>
  61       </Docs>
  62     </Member>
  63     <Member MemberName="ExportDefinitions">
  64       <MemberSignature Language="C#" Value="public abstract System.Collections.Generic.IEnumerable&lt;System.ComponentModel.Composition.Primitives.ExportDefinition&gt; ExportDefinitions { get; }" />
  65       <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1&lt;class System.ComponentModel.Composition.Primitives.ExportDefinition&gt; ExportDefinitions" />
  66       <MemberType>Property</MemberType>
  67       <AssemblyInfo>
  68         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  69       </AssemblyInfo>
  70       <ReturnValue>
  71         <ReturnType>System.Collections.Generic.IEnumerable&lt;System.ComponentModel.Composition.Primitives.ExportDefinition&gt;</ReturnType>
  72       </ReturnValue>
  73       <Docs>
  74         <value>To be added.</value>
  75         <remarks>
  76           <attribution license="cc4" from="Microsoft" modified="false" />
  77           <para>Overrides of this property should never return null. If the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePart" /> objects created by the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartDefinition" /> do not provide exported objects, return an empty <see cref="T:System.Collections.Generic.IEnumerable`1" /> collection instead.</para>
  78         </remarks>
  79         <summary>
  80           <attribution license="cc4" from="Microsoft" modified="false" />
  81           <para>Gets a collection of <see cref="T:System.ComponentModel.Composition.Primitives.ExportDefinition" /> objects that describe the objects exported by the part defined by this <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartDefinition" /> object.</para>
  82         </summary>
  83       </Docs>
  84     </Member>
  85     <Member MemberName="ImportDefinitions">
  86       <MemberSignature Language="C#" Value="public abstract System.Collections.Generic.IEnumerable&lt;System.ComponentModel.Composition.Primitives.ImportDefinition&gt; ImportDefinitions { get; }" />
  87       <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1&lt;class System.ComponentModel.Composition.Primitives.ImportDefinition&gt; ImportDefinitions" />
  88       <MemberType>Property</MemberType>
  89       <AssemblyInfo>
  90         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  91       </AssemblyInfo>
  92       <ReturnValue>
  93         <ReturnType>System.Collections.Generic.IEnumerable&lt;System.ComponentModel.Composition.Primitives.ImportDefinition&gt;</ReturnType>
  94       </ReturnValue>
  95       <Docs>
  96         <value>To be added.</value>
  97         <remarks>
  98           <attribution license="cc4" from="Microsoft" modified="false" />
  99           <para>Overrides of this property should never return null. If the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePart" /> objects created by the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartDefinition" /> do not have imports, return an empty <see cref="T:System.Collections.Generic.IEnumerable`1" /> collection instead.</para>
 100         </remarks>
 101         <summary>
 102           <attribution license="cc4" from="Microsoft" modified="false" />
 103           <para>Gets a collection of <see cref="T:System.ComponentModel.Composition.Primitives.ImportDefinition" /> objects that describe the imports required by the part defined by this <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartDefinition" /> object.</para>
 104         </summary>
 105       </Docs>
 106     </Member>
 107     <Member MemberName="Metadata">
 108       <MemberSignature Language="C#" Value="public virtual System.Collections.Generic.IDictionary&lt;string,object&gt; Metadata { get; }" />
 109       <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2&lt;string, object&gt; Metadata" />
 110       <MemberType>Property</MemberType>
 111       <AssemblyInfo>
 112         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 113       </AssemblyInfo>
 114       <ReturnValue>
 115         <ReturnType>System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;</ReturnType>
 116       </ReturnValue>
 117       <Docs>
 118         <value>To be added.</value>
 119         <remarks>
 120           <attribution license="cc4" from="Microsoft" modified="false" />
 121           <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.ComposablePartDefinition" /> does not contain metadata, return an empty <see cref="T:System.Collections.Generic.IDictionary`2" /> object instead.</para>
 122         </remarks>
 123         <summary>
 124           <attribution license="cc4" from="Microsoft" modified="false" />
 125           <para>Gets a collection of the metadata for this <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartDefinition" /> object.</para>
 126         </summary>
 127       </Docs>
 128     </Member>
 129   </Members>
 130 </Type>