EntityMetadata.PrimaryImageAttribute Property

Article
06/20/2014

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

Gets the name of the primary image attribute for an entity.

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

Syntax

'Declaration
<DataMemberAttribute(Order:=60)> _
Public Property PrimaryImageAttribute As String

[DataMemberAttribute(Order=60)] 
public string PrimaryImageAttribute { get; }

Property Value

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

Remarks

When an entity contains a ImageAttributeMetadata attribute this value will be the name of the attribute containing the image used in the application. For the initial release of Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online each entity can have only one image attribute and the logical name of that attribute is always entityimage. This property has been added to prepare for a future release in which entities may support multiple image attributes and there may be need to change which image is used as the primary image for the entity.

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),