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

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="ExportDefinition" FullName="System.ComponentModel.Composition.Primitives.ExportDefinition">
   3   <TypeSignature Language="C#" Value="public class ExportDefinition" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ExportDefinition 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>Describes the contract that a particular <see cref="T:System.ComponentModel.Composition.Primitives.Export" /> object satisfies.</para>
  18     </summary>
  19   </Docs>
  20   <Members>
  21     <Member MemberName=".ctor">
  22       <MemberSignature Language="C#" Value="protected ExportDefinition ();" />
  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.ExportDefinition.ContractName" /> property and optionally, the <see cref="P:System.ComponentModel.Composition.Primitives.ExportDefinition.Metadata" /> property. By default, <see cref="P:System.ComponentModel.Composition.Primitives.ExportDefinition.Metadata" /> returns an empty, read-only dictionary.</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.ExportDefinition" /> class.</para>
  37         </summary>
  38       </Docs>
  39     </Member>
  40     <Member MemberName=".ctor">
  41       <MemberSignature Language="C#" Value="public ExportDefinition (string contractName, System.Collections.Generic.IDictionary&lt;string,object&gt; metadata);" />
  42       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string contractName, class System.Collections.Generic.IDictionary`2&lt;string, object&gt; metadata) cil managed" />
  43       <MemberType>Constructor</MemberType>
  44       <AssemblyInfo>
  45         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  46       </AssemblyInfo>
  47       <Parameters>
  48         <Parameter Name="contractName" Type="System.String" />
  49         <Parameter Name="metadata" Type="System.Collections.Generic.IDictionary&lt;System.String,System.Object&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.Primitives.ExportDefinition" /> class with the specified contract name and metadata.</para>
  56         </summary>
  57         <param name="contractName">
  58           <attribution license="cc4" from="Microsoft" modified="false" />The contract name of the <see cref="T:System.ComponentModel.Composition.Primitives.ExportDefinition" /> object.</param>
  59         <param name="metadata">
  60           <attribution license="cc4" from="Microsoft" modified="false" />The metadata of the <see cref="T:System.ComponentModel.Composition.Primitives.ExportDefinition" /> or null to set the <see cref="P:System.ComponentModel.Composition.Primitives.ExportDefinition.Metadata" /> property to an empty, read-only <see cref="T:System.Collections.Generic.IDictionary`2" /> object.</param>
  61       </Docs>
  62     </Member>
  63     <Member MemberName="ContractName">
  64       <MemberSignature Language="C#" Value="public virtual string ContractName { get; }" />
  65       <MemberSignature Language="ILAsm" Value=".property instance string ContractName" />
  66       <MemberType>Property</MemberType>
  67       <AssemblyInfo>
  68         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  69       </AssemblyInfo>
  70       <ReturnValue>
  71         <ReturnType>System.String</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 or an empty string ("").</para>
  78         </remarks>
  79         <summary>
  80           <attribution license="cc4" from="Microsoft" modified="false" />
  81           <para>Gets the contract name.</para>
  82         </summary>
  83       </Docs>
  84     </Member>
  85     <Member MemberName="Metadata">
  86       <MemberSignature Language="C#" Value="public virtual System.Collections.Generic.IDictionary&lt;string,object&gt; Metadata { get; }" />
  87       <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2&lt;string, object&gt; Metadata" />
  88       <MemberType>Property</MemberType>
  89       <AssemblyInfo>
  90         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  91       </AssemblyInfo>
  92       <ReturnValue>
  93         <ReturnType>System.Collections.Generic.IDictionary&lt;System.String,System.Object&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 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.</para>
 100           <para>If the <see cref="T:System.ComponentModel.Composition.Primitives.ExportDefinition" /> does not contain metadata, return an empty <see cref="T:System.Collections.Generic.IDictionary`2" /> instead.</para>
 101         </remarks>
 102         <summary>
 103           <attribution license="cc4" from="Microsoft" modified="false" />
 104           <para>Gets the contract metadata.</para>
 105         </summary>
 106       </Docs>
 107     </Member>
 108     <Member MemberName="ToString">
 109       <MemberSignature Language="C#" Value="public override string ToString ();" />
 110       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
 111       <MemberType>Method</MemberType>
 112       <AssemblyInfo>
 113         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 114       </AssemblyInfo>
 115       <ReturnValue>
 116         <ReturnType>System.String</ReturnType>
 117       </ReturnValue>
 118       <Parameters />
 119       <Docs>
 120         <remarks>To be added.</remarks>
 121         <summary>
 122           <attribution license="cc4" from="Microsoft" modified="false" />
 123           <para>Returns a string representation of the export definition.</para>
 124         </summary>
 125         <returns>
 126           <attribution license="cc4" from="Microsoft" modified="false" />
 127           <para>A string representation of the export definition.</para>
 128         </returns>
 129       </Docs>
 130     </Member>
 131   </Members>
 132 </Type>