DescriptionAttribute Class
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Specifies a description for a property or event.
Inheritance Hierarchy
System.Object
System.Attribute
System.ComponentModel.DescriptionAttribute
Namespace: System.ComponentModel
Assembly: System (in System.dll)
Syntax
'Declaration
<AttributeUsageAttribute(AttributeTargets.All)> _
Public Class DescriptionAttribute _
Inherits Attribute
[AttributeUsageAttribute(AttributeTargets.All)]
public class DescriptionAttribute : Attribute
The DescriptionAttribute type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") .gif "Supported by Silverlight for Windows Phone") .gif "Supported by Xbox 360") |
DescriptionAttribute() | Initializes a new instance of the DescriptionAttribute class with no parameters. |
|
DescriptionAttribute(String) | Initializes a new instance of the DescriptionAttribute class with a description. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Description | Gets the description stored in this attribute. |
.gif "Protected property") |
DescriptionValue | Gets or sets the string stored as the description. |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | Returns whether the value of the specified object is equal to the current DescriptionAttribute. (Overrides Attribute.Equals(Object).) |
.gif "Protected method") |
Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
|
GetHashCode | Returns the hash code for this instance. (Overrides Attribute.GetHashCode().) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
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.) |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Public field") .gif "Static member") |
Default | Specifies the default value for the DescriptionAttribute, which is an empty string (""). This static field is read-only. |
Top
Remarks
A visual designer can display the specified description when referencing the component member, such as in a Properties window. Call Description to access the value of this attribute.
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0
XNA Framework
Supported in: Xbox 360, Windows Phone OS 7.0
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.