Ask Learn
Preview
Ask Learn is an AI assistant that can answer questions, clarify concepts, and define terms using trusted Microsoft documentation.
Please sign in to use Ask Learn.
Sign inThis browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets a value that is used to display a description in the UI.
public:
property System::String ^ Description { System::String ^ get(); void set(System::String ^ value); };
public string Description { get; set; }
public string? Description { get; set; }
member this.Description : string with get, set
Public Property Description As String
The value that is used to display a description in the UI.
The following example shows how to set the Description property.
[MetadataType(typeof(EmployeeMD))]
public partial class Employee {
public class EmployeeMD {
[Display(Name = "Last Name", Order = -9,
Prompt = "Enter Last Name", Description="Emp Last Name")]
public object LastName { get; set; }
[Display(Name = "Manager", AutoGenerateFilter=false)]
public object Employee1 { get; set; }
}
}
<MetadataType(GetType(EmployeeMD))> _
Public Class Employee
Public Class EmployeeMD
<Display(Name:="Last Name", Order:=-9, _
Prompt:="Enter Last Name", Description:="Emp Last Name")> _
Public Property LastName As Object
End Property
<Display(Name:="Manager", AutoGenerateFilter:=false)> _
Public Property Employee1 As Object
End Property
End Class
End Class
Do not use this property to get the value of the Description property. Use the GetDescription method instead.
The Description property is typically used as a tooltip or description UI element that is bound to the member using this attribute. The Dynamic Data Edit.ascx template will display the description as a tooltip in text-entry fields. A null
value or empty string is valid.
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10 |
.NET Framework | 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 2.0 (package-provided), 2.1 (package-provided) |
UWP | 10.0 |
.NET feedback
.NET is an open source project. Select a link to provide feedback:
Ask Learn is an AI assistant that can answer questions, clarify concepts, and define terms using trusted Microsoft documentation.
Please sign in to use Ask Learn.
Sign in