UniqueConstraint.IsPrimaryKey Property
Definition
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 a value indicating whether or not the constraint is on a primary key.
public:
property bool IsPrimaryKey { bool get(); };
public bool IsPrimaryKey { get; }
[System.Data.DataSysDescription("KeyConstraintIsPrimaryKeyDescr")]
public bool IsPrimaryKey { get; }
member this.IsPrimaryKey : bool
[<System.Data.DataSysDescription("KeyConstraintIsPrimaryKeyDescr")>]
member this.IsPrimaryKey : bool
Public ReadOnly Property IsPrimaryKey As Boolean
Property Value
true
, if the constraint is on a primary key; otherwise, false
.
- Attributes
Examples
The following example checks the IsPrimaryKey property.
Private Sub GetPrimaryKey()
Dim dataRelation As DataRelation
Dim uniqueConstraint As UniqueConstraint
' Get a DataRelation from a DataSet.
dataRelation = DataSet1.Relations("CustomerOrders")
' Get the ParentKeyConstraint.
uniqueConstraint = dataRelation.ParentKeyConstraint
' Test if the IsPrimaryKey is true.
If uniqueConstraint.IsPrimaryKey Then
Console.WriteLine("IsPrimaryKey=True")
Else
Console.WriteLine("IsPrimaryKey=False")
End If
End Sub
Remarks
A table usually includes a primary key that ensures every row is unique. In some tables, the primary key may be made up of more than one column. For example, a primary key for a table containing names might be made up of both the first and last names as well. To create a primary key with more than one column, set the Columns property to an array of DataColumn objects.