Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
146 lines (139 sloc) 8.9 KB
<Type Name="AssemblyDescriptionAttribute" FullName="System.Reflection.AssemblyDescriptionAttribute">
<TypeSignature Language="C#" Value="public sealed class AssemblyDescriptionAttribute : Attribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit AssemblyDescriptionAttribute extends System.Attribute" />
<TypeSignature Language="DocId" Value="T:System.Reflection.AssemblyDescriptionAttribute" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class AssemblyDescriptionAttribute&#xA;Inherits Attribute" />
<TypeSignature Language="C++ CLI" Value="public ref class AssemblyDescriptionAttribute sealed : Attribute" />
<TypeSignature Language="F#" Value="type AssemblyDescriptionAttribute = class&#xA; inherit Attribute" />
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.20.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="netcore-1.0;netcore-1.1;netcore-2.0;netcore-2.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netstandard-1.0;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.5;netstandard-1.6;netstandard-2.0;xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0;netframework-4.8;netcore-2.2;dotnet-uwp-10.0;netcore-3.0;netstandard-2.1">
<AttributeName>System.AttributeUsage(System.AttributeTargets.Assembly, Inherited=false)</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0;netframework-4.8">
<AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-1.1">
<AttributeName>System.AttributeUsage(System.AttributeTargets.Assembly, AllowMultiple=false)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Provides a text description for an assembly.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When you create a project in [!INCLUDE[vsprvsext](~/includes/vsprvsext-md.md)], this attribute is automatically applied with an empty string value. You can set its value in [!INCLUDE[vsprvslong](~/includes/vsprvslong-md.md)] by selecting the **Properties** for the project from the **File** menu, and then by clicking **Assembly Information**. The attribute is saved in the AssemblyInfo file in your project, and it must be removed before you can specify it in code; otherwise, you will get an error that the attribute cannot be applied multiple times.
When you right-click the assembly file in File Explorer, this attribute appears as the **Comments** value on the **Version** tab of the file properties dialog box.
## Examples
The following code example sets the <xref:System.Reflection.AssemblyDescriptionAttribute> for a simple assembly and indicates whether or not it was defined.
[!code-csharp[System.Reflection.AssemblyDescriptionAttribute#1](~/samples/snippets/csharp/VS_Snippets_CLR_System/system.reflection.assemblydescriptionattribute/CS/DescrAttr.cs#1)]
[!code-vb[System.Reflection.AssemblyDescriptionAttribute#1](~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.reflection.assemblydescriptionattribute/VB/DescrAttr.vb#1)]
]]></format>
</remarks>
<related type="Article" href="https://msdn.microsoft.com/library/1d8e3398-00d8-47d5-a084-214f9859d3d7">Accessing Custom Attributes</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AssemblyDescriptionAttribute (string description);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string description) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Reflection.AssemblyDescriptionAttribute.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (description As String)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; AssemblyDescriptionAttribute(System::String ^ description);" />
<MemberSignature Language="F#" Value="new System.Reflection.AssemblyDescriptionAttribute : string -&gt; System.Reflection.AssemblyDescriptionAttribute" Usage="new System.Reflection.AssemblyDescriptionAttribute description" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.20.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="description" Type="System.String" />
</Parameters>
<Docs>
<param name="description">The assembly description.</param>
<summary>Initializes a new instance of the <see cref="T:System.Reflection.AssemblyDescriptionAttribute" /> class.</summary>
<remarks>To be added.</remarks>
<related type="Article" href="https://msdn.microsoft.com/library/1d8e3398-00d8-47d5-a084-214f9859d3d7">Accessing Custom Attributes</related>
</Docs>
</Member>
<Member MemberName="Description">
<MemberSignature Language="C#" Value="public string Description { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Description" />
<MemberSignature Language="DocId" Value="P:System.Reflection.AssemblyDescriptionAttribute.Description" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Description As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ Description { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Description : string" Usage="System.Reflection.AssemblyDescriptionAttribute.Description" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.20.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets assembly description information.</summary>
<value>A string containing the assembly description.</value>
<remarks>To be added.</remarks>
<related type="Article" href="https://msdn.microsoft.com/library/1d8e3398-00d8-47d5-a084-214f9859d3d7">Accessing Custom Attributes</related>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.