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

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="Export" FullName="System.ComponentModel.Composition.Primitives.Export">
   3   <TypeSignature Language="C#" Value="public class Export" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Export 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 export, which is a type that consists of a delay-created exported object and the metadata that describes that object.</para>
  18     </summary>
  19   </Docs>
  20   <Members>
  21     <Member MemberName=".ctor">
  22       <MemberSignature Language="C#" Value="protected Export ();" />
  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.Export.Definition" /> property and the <see cref="M:System.ComponentModel.Composition.Primitives.Export.GetExportedValueCore" /> method.</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.Export" /> class.</para>
  37         </summary>
  38       </Docs>
  39     </Member>
  40     <Member MemberName=".ctor">
  41       <MemberSignature Language="C#" Value="public Export (System.ComponentModel.Composition.Primitives.ExportDefinition definition, Func&lt;object&gt; exportedValueGetter);" />
  42       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.ComponentModel.Composition.Primitives.ExportDefinition definition, class System.Func`1&lt;object&gt; exportedValueGetter) cil managed" />
  43       <MemberType>Constructor</MemberType>
  44       <AssemblyInfo>
  45         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  46       </AssemblyInfo>
  47       <Parameters>
  48         <Parameter Name="definition" Type="System.ComponentModel.Composition.Primitives.ExportDefinition" />
  49         <Parameter Name="exportedValueGetter" Type="System.Func&lt;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.Export" /> class with the specified export definition and exported object getter.</para>
  56         </summary>
  57         <param name="definition">
  58           <attribution license="cc4" from="Microsoft" modified="false" />An object that describes the contract that the <see cref="T:System.ComponentModel.Composition.Primitives.Export" /> object satisfies.</param>
  59         <param name="exportedValueGetter">
  60           <attribution license="cc4" from="Microsoft" modified="false" />A method that is called to create the exported object of the <see cref="T:System.ComponentModel.Composition.Primitives.Export" />. This delays the creation of the object until the <see cref="P:System.ComponentModel.Composition.Primitives.Export.Value" /> property is called. </param>
  61       </Docs>
  62     </Member>
  63     <Member MemberName=".ctor">
  64       <MemberSignature Language="C#" Value="public Export (string contractName, Func&lt;object&gt; exportedValueGetter);" />
  65       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string contractName, class System.Func`1&lt;object&gt; exportedValueGetter) cil managed" />
  66       <MemberType>Constructor</MemberType>
  67       <AssemblyInfo>
  68         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  69       </AssemblyInfo>
  70       <Parameters>
  71         <Parameter Name="contractName" Type="System.String" />
  72         <Parameter Name="exportedValueGetter" Type="System.Func&lt;System.Object&gt;" />
  73       </Parameters>
  74       <Docs>
  75         <remarks>To be added.</remarks>
  76         <summary>
  77           <attribution license="cc4" from="Microsoft" modified="false" />
  78           <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Primitives.Export" /> class with the specified contract name and exported value getter.</para>
  79         </summary>
  80         <param name="contractName">
  81           <attribution license="cc4" from="Microsoft" modified="false" />The contract name of the <see cref="T:System.ComponentModel.Composition.Primitives.Export" /> object.</param>
  82         <param name="exportedValueGetter">
  83           <attribution license="cc4" from="Microsoft" modified="false" />A method that is called to create the exported object of the <see cref="T:System.ComponentModel.Composition.Primitives.Export" />. This delays the creation of the object until the <see cref="P:System.ComponentModel.Composition.Primitives.Export.Value" /> method is called.</param>
  84       </Docs>
  85     </Member>
  86     <Member MemberName=".ctor">
  87       <MemberSignature Language="C#" Value="public Export (string contractName, System.Collections.Generic.IDictionary&lt;string,object&gt; metadata, Func&lt;object&gt; exportedValueGetter);" />
  88       <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, class System.Func`1&lt;object&gt; exportedValueGetter) cil managed" />
  89       <MemberType>Constructor</MemberType>
  90       <AssemblyInfo>
  91         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  92       </AssemblyInfo>
  93       <Parameters>
  94         <Parameter Name="contractName" Type="System.String" />
  95         <Parameter Name="metadata" Type="System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;" />
  96         <Parameter Name="exportedValueGetter" Type="System.Func&lt;System.Object&gt;" />
  97       </Parameters>
  98       <Docs>
  99         <remarks>To be added.</remarks>
 100         <summary>
 101           <attribution license="cc4" from="Microsoft" modified="false" />
 102           <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Primitives.Export" /> class with the specified contract name, metadata, and exported value getter.</para>
 103         </summary>
 104         <param name="contractName">
 105           <attribution license="cc4" from="Microsoft" modified="false" />The contract name of the <see cref="T:System.ComponentModel.Composition.Primitives.Export" /> object.</param>
 106         <param name="metadata">
 107           <attribution license="cc4" from="Microsoft" modified="false" />The metadata of the <see cref="T:System.ComponentModel.Composition.Primitives.Export" /> object or null to set the <see cref="P:System.ComponentModel.Composition.Primitives.Export.Metadata" /> property to an empty, read-only <see cref="T:System.Collections.Generic.IDictionary`2" /> object.</param>
 108         <param name="exportedValueGetter">
 109           <attribution license="cc4" from="Microsoft" modified="false" />A method that is called to create the exported object of the <see cref="T:System.ComponentModel.Composition.Primitives.Export" />. This delays the creation of the object until the <see cref="P:System.ComponentModel.Composition.Primitives.Export.Value" /> method is called.</param>
 110       </Docs>
 111     </Member>
 112     <Member MemberName="Definition">
 113       <MemberSignature Language="C#" Value="public virtual System.ComponentModel.Composition.Primitives.ExportDefinition Definition { get; }" />
 114       <MemberSignature Language="ILAsm" Value=".property instance class System.ComponentModel.Composition.Primitives.ExportDefinition Definition" />
 115       <MemberType>Property</MemberType>
 116       <AssemblyInfo>
 117         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 118       </AssemblyInfo>
 119       <ReturnValue>
 120         <ReturnType>System.ComponentModel.Composition.Primitives.ExportDefinition</ReturnType>
 121       </ReturnValue>
 122       <Docs>
 123         <value>To be added.</value>
 124         <remarks>
 125           <attribution license="cc4" from="Microsoft" modified="false" />
 126           <para>Overrides of this property should never return null.</para>
 127         </remarks>
 128         <summary>
 129           <attribution license="cc4" from="Microsoft" modified="false" />
 130           <para>Gets the definition that describes the contract that the export satisfies.</para>
 131         </summary>
 132       </Docs>
 133     </Member>
 134     <Member MemberName="GetExportedValueCore">
 135       <MemberSignature Language="C#" Value="protected virtual object GetExportedValueCore ();" />
 136       <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance object GetExportedValueCore() cil managed" />
 137       <MemberType>Method</MemberType>
 138       <AssemblyInfo>
 139         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 140       </AssemblyInfo>
 141       <ReturnValue>
 142         <ReturnType>System.Object</ReturnType>
 143       </ReturnValue>
 144       <Parameters />
 145       <Docs>
 146         <remarks>To be added.</remarks>
 147         <summary>
 148           <attribution license="cc4" from="Microsoft" modified="false" />
 149           <para>Returns the exported object the export provides.</para>
 150         </summary>
 151         <returns>
 152           <attribution license="cc4" from="Microsoft" modified="false" />
 153           <para>The exported object the export provides.</para>
 154         </returns>
 155       </Docs>
 156     </Member>
 157     <Member MemberName="Metadata">
 158       <MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary&lt;string,object&gt; Metadata { get; }" />
 159       <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2&lt;string, object&gt; Metadata" />
 160       <MemberType>Property</MemberType>
 161       <AssemblyInfo>
 162         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 163       </AssemblyInfo>
 164       <ReturnValue>
 165         <ReturnType>System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;</ReturnType>
 166       </ReturnValue>
 167       <Docs>
 168         <value>To be added.</value>
 169         <remarks>
 170           <attribution license="cc4" from="Microsoft" modified="false" />
 171           <para>This property returns the value of <see cref="P:System.ComponentModel.Composition.Primitives.ExportDefinition.Metadata" /> of the <see cref="P:System.ComponentModel.Composition.Primitives.Export.Definition" /> property.</para>
 172         </remarks>
 173         <summary>
 174           <attribution license="cc4" from="Microsoft" modified="false" />
 175           <para>Gets the metadata for the export.</para>
 176         </summary>
 177       </Docs>
 178     </Member>
 179     <Member MemberName="Value">
 180       <MemberSignature Language="C#" Value="public object Value { get; }" />
 181       <MemberSignature Language="ILAsm" Value=".property instance object Value" />
 182       <MemberType>Property</MemberType>
 183       <AssemblyInfo>
 184         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 185       </AssemblyInfo>
 186       <ReturnValue>
 187         <ReturnType>System.Object</ReturnType>
 188       </ReturnValue>
 189       <Docs>
 190         <value>To be added.</value>
 191         <remarks>To be added.</remarks>
 192         <summary>
 193           <attribution license="cc4" from="Microsoft" modified="false" />
 194           <para>Provides the object this export represents.</para>
 195         </summary>
 196       </Docs>
 197     </Member>
 198   </Members>
 199 </Type>