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

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="ImportDefinition" FullName="System.ComponentModel.Composition.Primitives.ImportDefinition">
   3   <TypeSignature Language="C#" Value="public class ImportDefinition" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ImportDefinition 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>Represents an import that is required by a <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePart" /> object.</para>
  18     </summary>
  19   </Docs>
  20   <Members>
  21     <Member MemberName=".ctor">
  22       <MemberSignature Language="C#" Value="protected ImportDefinition ();" />
  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>
  31           <attribution license="cc4" from="Microsoft" modified="false" />
  32           <para>Derived types that call this constructor must override the <see cref="P:System.ComponentModel.Composition.Primitives.ImportDefinition.Constraint" /> property, and optionally, the <see cref="P:System.ComponentModel.Composition.Primitives.ImportDefinition.Cardinality" />, <see cref="P:System.ComponentModel.Composition.Primitives.ImportDefinition.IsPrerequisite" /> and <see cref="P:System.ComponentModel.Composition.Primitives.ImportDefinition.IsRecomposable" /> properties.</para>
  33         </remarks>
  34         <summary>
  35           <attribution license="cc4" from="Microsoft" modified="false" />
  36           <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Primitives.ImportDefinition" /> class.</para>
  37         </summary>
  38       </Docs>
  39     </Member>
  40     <Member MemberName=".ctor">
  41       <MemberSignature Language="C#" Value="public ImportDefinition (System.Linq.Expressions.Expression&lt;Func&lt;System.ComponentModel.Composition.Primitives.ExportDefinition,bool&gt;&gt; constraint, string contractName, System.ComponentModel.Composition.Primitives.ImportCardinality cardinality, bool isRecomposable, bool isPrerequisite);" />
  42       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Linq.Expressions.Expression`1&lt;class System.Func`2&lt;class System.ComponentModel.Composition.Primitives.ExportDefinition, bool&gt;&gt; constraint, string contractName, valuetype System.ComponentModel.Composition.Primitives.ImportCardinality cardinality, bool isRecomposable, bool isPrerequisite) cil managed" />
  43       <MemberType>Constructor</MemberType>
  44       <AssemblyInfo>
  45         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  46       </AssemblyInfo>
  47       <Parameters>
  48         <Parameter Name="constraint" Type="System.Linq.Expressions.Expression&lt;System.Func&lt;System.ComponentModel.Composition.Primitives.ExportDefinition,System.Boolean&gt;&gt;" />
  49         <Parameter Name="contractName" Type="System.String" />
  50         <Parameter Name="cardinality" Type="System.ComponentModel.Composition.Primitives.ImportCardinality" />
  51         <Parameter Name="isRecomposable" Type="System.Boolean" />
  52         <Parameter Name="isPrerequisite" Type="System.Boolean" />
  53       </Parameters>
  54       <Docs>
  55         <remarks>To be added.</remarks>
  56         <summary>
  57           <attribution license="cc4" from="Microsoft" modified="false" />
  58           <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Primitives.ImportDefinition" /> class with the specified constraint, contract name, and cardinality, and indicates whether the import definition is recomposable or a prerequisite.</para>
  59         </summary>
  60         <param name="constraint">
  61           <attribution license="cc4" from="Microsoft" modified="false" />An expression that contains a <see cref="T:System.Func`2" /> object that defines the conditions an <see cref="T:System.ComponentModel.Composition.Primitives.Export" /> must match to satisfy the import definition.</param>
  62         <param name="contractName">
  63           <attribution license="cc4" from="Microsoft" modified="false" />The contract name.</param>
  64         <param name="cardinality">
  65           <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that indicates the cardinality of the <see cref="T:System.ComponentModel.Composition.Primitives.Export" /> objects required by the import definition.</param>
  66         <param name="isRecomposable">
  67           <attribution license="cc4" from="Microsoft" modified="false" />true to specify that the import definition can be satisfied multiple times throughout the lifetime of a <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePart" /> object; otherwise, false.</param>
  68         <param name="isPrerequisite">
  69           <attribution license="cc4" from="Microsoft" modified="false" />true to specify that the import definition must be satisfied before a <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePart" /> can start producing exported objects; otherwise, false.</param>
  70       </Docs>
  71     </Member>
  72     <Member MemberName=".ctor">
  73       <MemberSignature Language="C#" Value="public ImportDefinition (System.Linq.Expressions.Expression&lt;Func&lt;System.ComponentModel.Composition.Primitives.ExportDefinition,bool&gt;&gt; constraint, string contractName, System.ComponentModel.Composition.Primitives.ImportCardinality cardinality, bool isRecomposable, bool isPrerequisite, System.Collections.Generic.IDictionary&lt;string,object&gt; metadata);" />
  74       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Linq.Expressions.Expression`1&lt;class System.Func`2&lt;class System.ComponentModel.Composition.Primitives.ExportDefinition, bool&gt;&gt; constraint, string contractName, valuetype System.ComponentModel.Composition.Primitives.ImportCardinality cardinality, bool isRecomposable, bool isPrerequisite, class System.Collections.Generic.IDictionary`2&lt;string, object&gt; metadata) cil managed" />
  75       <MemberType>Constructor</MemberType>
  76       <AssemblyInfo>
  77         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  78       </AssemblyInfo>
  79       <Parameters>
  80         <Parameter Name="constraint" Type="System.Linq.Expressions.Expression&lt;System.Func&lt;System.ComponentModel.Composition.Primitives.ExportDefinition,System.Boolean&gt;&gt;" />
  81         <Parameter Name="contractName" Type="System.String" />
  82         <Parameter Name="cardinality" Type="System.ComponentModel.Composition.Primitives.ImportCardinality" />
  83         <Parameter Name="isRecomposable" Type="System.Boolean" />
  84         <Parameter Name="isPrerequisite" Type="System.Boolean" />
  85         <Parameter Name="metadata" Type="System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;" />
  86       </Parameters>
  87       <Docs>
  88         <remarks>To be added.</remarks>
  89         <summary>
  90           <attribution license="cc4" from="Microsoft" modified="false" />
  91           <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Primitives.ImportDefinition" /> class with the specified constraint, contract name, cardinality, and metadata, and indicates whether the import definition is recomposable or a prerequisite.</para>
  92         </summary>
  93         <param name="constraint">
  94           <attribution license="cc4" from="Microsoft" modified="false" />An expression that contains a <see cref="T:System.Func`2" /> object that defines the conditions an <see cref="T:System.ComponentModel.Composition.Primitives.Export" /> must match to satisfy the import definition.</param>
  95         <param name="contractName">
  96           <attribution license="cc4" from="Microsoft" modified="false" />The contract name.</param>
  97         <param name="cardinality">
  98           <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that indicates the cardinality of the <see cref="T:System.ComponentModel.Composition.Primitives.Export" /> objects required by the import definition.</param>
  99         <param name="isRecomposable">
 100           <attribution license="cc4" from="Microsoft" modified="false" />true to specify that the import definition can be satisfied multiple times throughout the lifetime of a <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePart" /> object; otherwise, false.</param>
 101         <param name="isPrerequisite">
 102           <attribution license="cc4" from="Microsoft" modified="false" />true to specify that the import definition must be satisfied before a <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePart" /> can start producing exported objects; otherwise, false.</param>
 103         <param name="metadata">
 104           <attribution license="cc4" from="Microsoft" modified="false" />The metadata associated with the import.</param>
 105       </Docs>
 106     </Member>
 107     <Member MemberName="Cardinality">
 108       <MemberSignature Language="C#" Value="public virtual System.ComponentModel.Composition.Primitives.ImportCardinality Cardinality { get; }" />
 109       <MemberSignature Language="ILAsm" Value=".property instance valuetype System.ComponentModel.Composition.Primitives.ImportCardinality Cardinality" />
 110       <MemberType>Property</MemberType>
 111       <AssemblyInfo>
 112         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 113       </AssemblyInfo>
 114       <ReturnValue>
 115         <ReturnType>System.ComponentModel.Composition.Primitives.ImportCardinality</ReturnType>
 116       </ReturnValue>
 117       <Docs>
 118         <value>To be added.</value>
 119         <remarks>To be added.</remarks>
 120         <summary>
 121           <attribution license="cc4" from="Microsoft" modified="false" />
 122           <para>Gets the cardinality of the exports required by the import definition.</para>
 123         </summary>
 124       </Docs>
 125     </Member>
 126     <Member MemberName="Constraint">
 127       <MemberSignature Language="C#" Value="public virtual System.Linq.Expressions.Expression&lt;Func&lt;System.ComponentModel.Composition.Primitives.ExportDefinition,bool&gt;&gt; Constraint { get; }" />
 128       <MemberSignature Language="ILAsm" Value=".property instance class System.Linq.Expressions.Expression`1&lt;class System.Func`2&lt;class System.ComponentModel.Composition.Primitives.ExportDefinition, bool&gt;&gt; Constraint" />
 129       <MemberType>Property</MemberType>
 130       <AssemblyInfo>
 131         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 132       </AssemblyInfo>
 133       <ReturnValue>
 134         <ReturnType>System.Linq.Expressions.Expression&lt;System.Func&lt;System.ComponentModel.Composition.Primitives.ExportDefinition,System.Boolean&gt;&gt;</ReturnType>
 135       </ReturnValue>
 136       <Docs>
 137         <value>To be added.</value>
 138         <remarks>
 139           <attribution license="cc4" from="Microsoft" modified="false" />
 140           <para>Overrides of this property should never return null.</para>
 141         </remarks>
 142         <summary>
 143           <attribution license="cc4" from="Microsoft" modified="false" />
 144           <para>Gets an expression that defines conditions that the import must satisfy to match the import definition.</para>
 145         </summary>
 146       </Docs>
 147     </Member>
 148     <Member MemberName="ContractName">
 149       <MemberSignature Language="C#" Value="public virtual string ContractName { get; }" />
 150       <MemberSignature Language="ILAsm" Value=".property instance string ContractName" />
 151       <MemberType>Property</MemberType>
 152       <AssemblyInfo>
 153         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 154       </AssemblyInfo>
 155       <ReturnValue>
 156         <ReturnType>System.String</ReturnType>
 157       </ReturnValue>
 158       <Docs>
 159         <value>To be added.</value>
 160         <remarks>To be added.</remarks>
 161         <summary>
 162           <attribution license="cc4" from="Microsoft" modified="false" />
 163           <para>Gets the name of the contract.</para>
 164         </summary>
 165       </Docs>
 166     </Member>
 167     <Member MemberName="IsConstraintSatisfiedBy">
 168       <MemberSignature Language="C#" Value="public virtual bool IsConstraintSatisfiedBy (System.ComponentModel.Composition.Primitives.ExportDefinition exportDefinition);" />
 169       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool IsConstraintSatisfiedBy(class System.ComponentModel.Composition.Primitives.ExportDefinition exportDefinition) cil managed" />
 170       <MemberType>Method</MemberType>
 171       <AssemblyInfo>
 172         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 173       </AssemblyInfo>
 174       <ReturnValue>
 175         <ReturnType>System.Boolean</ReturnType>
 176       </ReturnValue>
 177       <Parameters>
 178         <Parameter Name="exportDefinition" Type="System.ComponentModel.Composition.Primitives.ExportDefinition" />
 179       </Parameters>
 180       <Docs>
 181         <remarks>To be added.</remarks>
 182         <summary>
 183           <attribution license="cc4" from="Microsoft" modified="false" />
 184           <para>Gets a value that indicates whether the export represented by the specified definition satisfies the constraints of this import definition.</para>
 185         </summary>
 186         <returns>
 187           <attribution license="cc4" from="Microsoft" modified="false" />
 188           <para>true if the constraints are satisfied; otherwise, false.</para>
 189         </returns>
 190         <param name="exportDefinition">
 191           <attribution license="cc4" from="Microsoft" modified="false" />The export definition to test.</param>
 192       </Docs>
 193     </Member>
 194     <Member MemberName="IsPrerequisite">
 195       <MemberSignature Language="C#" Value="public virtual bool IsPrerequisite { get; }" />
 196       <MemberSignature Language="ILAsm" Value=".property instance bool IsPrerequisite" />
 197       <MemberType>Property</MemberType>
 198       <AssemblyInfo>
 199         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 200       </AssemblyInfo>
 201       <ReturnValue>
 202         <ReturnType>System.Boolean</ReturnType>
 203       </ReturnValue>
 204       <Docs>
 205         <value>To be added.</value>
 206         <remarks>To be added.</remarks>
 207         <summary>
 208           <attribution license="cc4" from="Microsoft" modified="false" />
 209           <para>Gets a value that indicates whether the import definition must be satisfied before a part can start producing exported objects.</para>
 210         </summary>
 211       </Docs>
 212     </Member>
 213     <Member MemberName="IsRecomposable">
 214       <MemberSignature Language="C#" Value="public virtual bool IsRecomposable { get; }" />
 215       <MemberSignature Language="ILAsm" Value=".property instance bool IsRecomposable" />
 216       <MemberType>Property</MemberType>
 217       <AssemblyInfo>
 218         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 219       </AssemblyInfo>
 220       <ReturnValue>
 221         <ReturnType>System.Boolean</ReturnType>
 222       </ReturnValue>
 223       <Docs>
 224         <value>To be added.</value>
 225         <remarks>To be added.</remarks>
 226         <summary>
 227           <attribution license="cc4" from="Microsoft" modified="false" />
 228           <para>Gets a value that indicates whether the import definition can be satisfied multiple times.</para>
 229         </summary>
 230       </Docs>
 231     </Member>
 232     <Member MemberName="Metadata">
 233       <MemberSignature Language="C#" Value="public virtual System.Collections.Generic.IDictionary&lt;string,object&gt; Metadata { get; }" />
 234       <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2&lt;string, object&gt; Metadata" />
 235       <MemberType>Property</MemberType>
 236       <AssemblyInfo>
 237         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 238       </AssemblyInfo>
 239       <ReturnValue>
 240         <ReturnType>System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;</ReturnType>
 241       </ReturnValue>
 242       <Docs>
 243         <value>To be added.</value>
 244         <remarks>
 245           <attribution license="cc4" from="Microsoft" modified="false" />
 246           <para>This property should never return null. Imports with no metadata should return an empty <see cref="T:System.Collections.Generic.IDictionary`2" /> collection.</para>
 247         </remarks>
 248         <summary>
 249           <attribution license="cc4" from="Microsoft" modified="false" />
 250           <para>Gets the metadata associated with this import.</para>
 251         </summary>
 252       </Docs>
 253     </Member>
 254     <Member MemberName="ToString">
 255       <MemberSignature Language="C#" Value="public override string ToString ();" />
 256       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
 257       <MemberType>Method</MemberType>
 258       <AssemblyInfo>
 259         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 260       </AssemblyInfo>
 261       <ReturnValue>
 262         <ReturnType>System.String</ReturnType>
 263       </ReturnValue>
 264       <Parameters />
 265       <Docs>
 266         <remarks>To be added.</remarks>
 267         <summary>
 268           <attribution license="cc4" from="Microsoft" modified="false" />
 269           <para>Returns a string representation of the import definition.</para>
 270         </summary>
 271         <returns>
 272           <attribution license="cc4" from="Microsoft" modified="false" />
 273           <para>A string representation of the import definition.</para>
 274         </returns>
 275       </Docs>
 276     </Member>
 277   </Members>
 278 </Type>