This documentation is archived and is not being maintained.

DataObjectFieldAttribute.PrimaryKey Property

Gets a value indicating whether a property is in the primary key in the underlying data.

Namespace:  System.ComponentModel
Assembly:  System (in System.dll)

public bool PrimaryKey { get; }

Property Value

Type: System.Boolean
true if the property is in the primary key of the data store; otherwise, false.

Set the PrimaryKey property to true when the DataObjectFieldAttribute attribute is applied to a property that represents the primary key value of the underlying data. The primary key is typically used by the underlying data store to uniquely identify an entity in the data store, and often is, but is not required to be, a data store identity field.

Set the PrimaryKey property with one of the DataObjectFieldAttribute constructors.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.