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         <param name="contractName">To be added.</param>
  53         <param name="metadata">To be added.</param>
  54         <summary>To be added.</summary>
  55         <remarks>To be added.</remarks>
  56       </Docs>
  57     </Member>
  58     <Member MemberName="ContractName">
  59       <MemberSignature Language="C#" Value="public virtual string ContractName { get; }" />
  60       <MemberSignature Language="ILAsm" Value=".property instance string ContractName" />
  61       <MemberType>Property</MemberType>
  62       <AssemblyInfo>
  63         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  64       </AssemblyInfo>
  65       <ReturnValue>
  66         <ReturnType>System.String</ReturnType>
  67       </ReturnValue>
  68       <Docs>
  69         <value>To be added.</value>
  70         <remarks>
  71           <attribution license="cc4" from="Microsoft" modified="false" />
  72           <para>Overrides of this property should never return null or an empty string ("").</para>
  73         </remarks>
  74         <summary>
  75           <attribution license="cc4" from="Microsoft" modified="false" />
  76           <para>Gets the contract name.</para>
  77         </summary>
  78       </Docs>
  79     </Member>
  80     <Member MemberName="Metadata">
  81       <MemberSignature Language="C#" Value="public virtual System.Collections.Generic.IDictionary&lt;string,object&gt; Metadata { get; }" />
  82       <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2&lt;string, object&gt; Metadata" />
  83       <MemberType>Property</MemberType>
  84       <AssemblyInfo>
  85         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  86       </AssemblyInfo>
  87       <ReturnValue>
  88         <ReturnType>System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;</ReturnType>
  89       </ReturnValue>
  90       <Docs>
  91         <value>To be added.</value>
  92         <remarks>
  93           <attribution license="cc4" from="Microsoft" modified="false" />
  94           <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>
  95           <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>
  96         </remarks>
  97         <summary>
  98           <attribution license="cc4" from="Microsoft" modified="false" />
  99           <para>Gets the contract metadata.</para>
 100         </summary>
 101       </Docs>
 102     </Member>
 103     <Member MemberName="ToString">
 104       <MemberSignature Language="C#" Value="public override string ToString ();" />
 105       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
 106       <MemberType>Method</MemberType>
 107       <AssemblyInfo>
 108         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 109       </AssemblyInfo>
 110       <ReturnValue>
 111         <ReturnType>System.String</ReturnType>
 112       </ReturnValue>
 113       <Parameters />
 114       <Docs>
 115         <returns>To be added.</returns>
 116         <remarks>To be added.</remarks>
 117         <summary>
 118           <attribution license="cc4" from="Microsoft" modified="false" />
 119           <para>Returns a string representation of the export definition.</para>
 120         </summary>
 121       </Docs>
 122     </Member>
 123   </Members>
 124 </Type>