Edit

Share via


UniqueConstraint.IsPrimaryKey Property

Definition

Gets a value indicating whether or not the constraint is on a primary key.

C#
public bool IsPrimaryKey { get; }
C#
[System.Data.DataSysDescription("KeyConstraintIsPrimaryKeyDescr")]
public bool IsPrimaryKey { get; }

Property Value

true, if the constraint is on a primary key; otherwise, false.

Attributes

Examples

The following example checks the IsPrimaryKey property.

VB
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.

Applies to

Product Versions
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1

See also