DataObjectFieldAttribute.PrimaryKey Property

Definition

Namespace:

System.ComponentModel

Assembly:

System.ComponentModel.TypeConverter.dll

Source:

DataObjectFieldAttribute.cs

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

public:
 property bool PrimaryKey { bool get(); };

public bool PrimaryKey { get; }

member this.PrimaryKey : bool

Public ReadOnly Property PrimaryKey As Boolean

Property Value

Boolean

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

Remarks

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.