AssemblyDescriptionAttribute Class
Provides a text description for an assembly.
Assembly: mscorlib (in mscorlib.dll)
The AssemblyDescriptionAttribute type exposes the following members.
| Name | Description | |
|---|---|---|
|
AssemblyDescriptionAttribute | Initializes a new instance of the AssemblyDescriptionAttribute class. |
| Name | Description | |
|---|---|---|
|
Description | Gets assembly description information. |
|
|
TypeId | When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.) |
| Name | Description | |
|---|---|---|
|
|
Equals | Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetHashCode | Returns the hash code for this instance. (Inherited from Attribute.) |
|
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
|
IsDefaultAttribute | When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.) |
|
|
Match | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.) |
|
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
|
_Attribute.GetIDsOfNames | Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.) |
|
|
_Attribute.GetTypeInfo | Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.) |
|
|
_Attribute.GetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.) |
|
|
_Attribute.Invoke | Provides access to properties and methods exposed by an object. (Inherited from Attribute.) |
When you create a project in Microsoft Visual Studio 2005, this attribute is automatically applied with an empty string value. You can set its value in Visual Studio 2005 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 Windows Explorer, this attribute appears as the Comments value on the Version tab of the file properties dialog box.
The following code example sets the AssemblyDescriptionAttribute for a simple assembly and indicates whether or not it was defined.
using System; using System.Reflection; [assembly:AssemblyDescriptionAttribute("My Utility")] public class Test { public static void Main() { // Get the assembly. Assembly asm = Assembly.GetCallingAssembly(); // Verify that the description is applied. Type aType = typeof(AssemblyDescriptionAttribute); Console.WriteLine("Description applied: {0}", asm.IsDefined(aType, false)); } } // The output is: // Description Applied: True
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
