mcs/class/corlib/Documentation/en/System.Runtime.Versioning/TargetFrameworkAttribute.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="TargetFrameworkAttribute" FullName="System.Runtime.Versioning.TargetFrameworkAttribute">
   3   <TypeSignature Language="C#" Value="public sealed class TargetFrameworkAttribute : Attribute" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit TargetFrameworkAttribute extends System.Attribute" />
   5   <AssemblyInfo>
   6     <AssemblyName>mscorlib</AssemblyName>
   7     <AssemblyVersion>4.0.0.0</AssemblyVersion>
   8   </AssemblyInfo>
   9   <Base>
  10     <BaseTypeName>System.Attribute</BaseTypeName>
  11   </Base>
  12   <Interfaces />
  13   <Attributes>
  14     <Attribute>
  15       <AttributeName>System.AttributeUsage(System.AttributeTargets.Assembly, AllowMultiple=false, Inherited=false)</AttributeName>
  16     </Attribute>
  17   </Attributes>
  18   <Docs>
  19     <remarks>
  20       <attribution license="cc4" from="Microsoft" modified="false" />
  21       <para>The <see cref="T:System.Runtime.Versioning.TargetFrameworkAttribute" /> class provides an attribute that you can apply to an assembly to indicate the version of the .NET Framework runtime against which the assembly was built. For example, the following example applies the TargetFrameworkAttribute to an assembly to indicate that it was built using net_v40_long.</para>
  22       <para>code reference: System.Runtime.Versioning.TargetFrameworkAttribute#1</para>
  23       <para>The <see cref="T:System.Runtime.Versioning.TargetFrameworkAttribute" /> class constructor has a single parameter, <paramref name="frameworkName" />, that specifies the .NET Framework version against which the assembly was built. This parameter maps to the <see cref="P:System.Runtime.Versioning.TargetFrameworkAttribute.FrameworkName" /> property. In addition, the <see cref="T:System.Runtime.Versioning.TargetFrameworkAttribute" /> attribute can specify a <see cref="P:System.Runtime.Versioning.TargetFrameworkAttribute.FrameworkDisplayName" /> property to provide a more descriptive .NET Framework version string that is suitable for displaying to clients of the assembly. The following example applies the TargetFrameworkAttribute to an assembly and assigns both property values to indicate that the assembly was built using net_v40_long. </para>
  24       <para>code reference: System.Runtime.Versioning.TargetFrameworkAttribute#2</para>
  25     </remarks>
  26     <summary>
  27       <attribution license="cc4" from="Microsoft" modified="false" />
  28       <para>Identifies the version of the .NET Framework that a particular assembly was compiled against.</para>
  29     </summary>
  30   </Docs>
  31   <Members>
  32     <Member MemberName=".ctor">
  33       <MemberSignature Language="C#" Value="public TargetFrameworkAttribute (string frameworkName);" />
  34       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string frameworkName) cil managed" />
  35       <MemberType>Constructor</MemberType>
  36       <AssemblyInfo>
  37         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  38       </AssemblyInfo>
  39       <Parameters>
  40         <Parameter Name="frameworkName" Type="System.String" />
  41       </Parameters>
  42       <Docs>
  43         <remarks>
  44           <attribution license="cc4" from="Microsoft" modified="false" />
  45           <para>The string that is assigned to the <paramref name="frameworkName" /> parameter generally takes the same form as the string that is returned by the <see cref="M:System.Runtime.Versioning.FrameworkName.ToString" /> method.</para>
  46         </remarks>
  47         <summary>
  48           <attribution license="cc4" from="Microsoft" modified="false" />
  49           <para>Initializes an instance of the <see cref="T:System.Runtime.Versioning.TargetFrameworkAttribute" /> class by specifying the .NET Framework version against which an assembly was built.</para>
  50         </summary>
  51         <param name="frameworkName">
  52           <attribution license="cc4" from="Microsoft" modified="false" />The version of the .NET Framework against which the assembly was built.</param>
  53       </Docs>
  54     </Member>
  55     <Member MemberName="FrameworkDisplayName">
  56       <MemberSignature Language="C#" Value="public string FrameworkDisplayName { get; set; }" />
  57       <MemberSignature Language="ILAsm" Value=".property instance string FrameworkDisplayName" />
  58       <MemberType>Property</MemberType>
  59       <AssemblyInfo>
  60         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  61       </AssemblyInfo>
  62       <ReturnValue>
  63         <ReturnType>System.String</ReturnType>
  64       </ReturnValue>
  65       <Docs>
  66         <value>To be added.</value>
  67         <remarks>
  68           <attribution license="cc4" from="Microsoft" modified="false" />
  69           <para>The <see cref="P:System.Runtime.Versioning.TargetFrameworkAttribute.FrameworkDisplayName" /> property usually returns a relatively long descriptive string that is suitable for display to a user. </para>
  70         </remarks>
  71         <summary>
  72           <attribution license="cc4" from="Microsoft" modified="false" />
  73           <para>Gets the display name of the .NET Framework version against which an assembly was built.</para>
  74         </summary>
  75       </Docs>
  76     </Member>
  77     <Member MemberName="FrameworkName">
  78       <MemberSignature Language="C#" Value="public string FrameworkName { get; }" />
  79       <MemberSignature Language="ILAsm" Value=".property instance string FrameworkName" />
  80       <MemberType>Property</MemberType>
  81       <AssemblyInfo>
  82         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  83       </AssemblyInfo>
  84       <ReturnValue>
  85         <ReturnType>System.String</ReturnType>
  86       </ReturnValue>
  87       <Docs>
  88         <value>To be added.</value>
  89         <remarks>
  90           <attribution license="cc4" from="Microsoft" modified="false" />
  91           <para>The <see cref="P:System.Runtime.Versioning.TargetFrameworkAttribute.FrameworkName" /> property maps to the <paramref name="frameworkName" /> parameter of the <see cref="M:System.Runtime.Versioning.TargetFrameworkAttribute.#ctor(System.String)" /> constructor. It represents the .NET Framework version in a compact form and typically corresponds to the string that is returned by the <see cref="M:System.Runtime.Versioning.FrameworkName.ToString" /> method. </para>
  92         </remarks>
  93         <summary>
  94           <attribution license="cc4" from="Microsoft" modified="false" />
  95           <para>Gets the name of the .NET Framework version against which a particular assembly was compiled.</para>
  96         </summary>
  97       </Docs>
  98     </Member>
  99   </Members>
 100 </Type>