EntityMetadata.PrimaryNameAttribute Property

Article
06/20/2014

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Gets the name of the primary attribute for an entity.

Namespace: Microsoft.Xrm.Sdk.Metadata
Assembly: Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Syntax

'Declaration
<DataMemberAttribute> _
Public Property PrimaryNameAttribute As String

[DataMemberAttribute] 
public string PrimaryNameAttribute { get; }

Property Value

Type: String
The name of the primary attribute for an entity..

Remarks

Each entity that contains records that can appear in the application will have a primary attribute. Each custom entity will have a primary attribute. The default name for the primary attribute is ‘name’ and this is the most common value for PrimaryNameAttribute. The value in the corresponding attribute is the value that will appear in a lookup attribute when that record is selected. Many entities do not appear in the application and do not have a value set for PrimaryNameAttribute.

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.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),