Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

DisplayAttribute.Name Property

Definition

Namespace:
System.ComponentModel.DataAnnotations
Assemblies:
System.ComponentModel.Annotations.dll, System.ComponentModel.DataAnnotations.dll
Assembly:
System.ComponentModel.Annotations.dll
Assembly:
System.ComponentModel.DataAnnotations.dll
Source:
DisplayAttribute.cs
Source:
DisplayAttribute.cs
Source:
DisplayAttribute.cs
Source:
DisplayAttribute.cs
Source:
DisplayAttribute.cs

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 for display in the UI.

public:
 property System::String ^ Name { System::String ^ get(); void set(System::String ^ value); };
public string Name { get; set; }
public string? Name { get; set; }
member this.Name : string with get, set
Public Property Name As String

Property Value

A value that is used for display in the UI.

Examples

The following example shows how to set the name 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

Remarks

Do not use this property to get the value of the Name property. Use the GetName method instead.

The name is typically used as the field label for a UI element that is bound to the property that is annotated with this attribute. The Dynamic Data List.aspx, ListDetails.aspx, and Details.aspx page templates use the Name property for the field label. A null value or empty string is valid.

Applies to


Feedback

Was this page helpful?