DataTable.PrimaryKey Egenskap

Definition

Namnområde:

System.Data

Sammansättningar:

netstandard.dll, System.Data.Common.dll

Källa:

DataTable.cs

Hämtar eller anger en matris med kolumner som fungerar som primära nycklar för datatabellen.

public:
 property cli::array <System::Data::DataColumn ^> ^ PrimaryKey { cli::array <System::Data::DataColumn ^> ^ get(); void set(cli::array <System::Data::DataColumn ^> ^ value); };

[System.ComponentModel.TypeConverter(typeof(System.Data.PrimaryKeyTypeConverter))]
public System.Data.DataColumn[] PrimaryKey { get; set; }

[<System.ComponentModel.TypeConverter(typeof(System.Data.PrimaryKeyTypeConverter))>]
member this.PrimaryKey : System.Data.DataColumn[] with get, set

Public Property PrimaryKey As DataColumn()

Egenskapsvärde

DataColumn[]

En matris med DataColumn objekt.

Attribut

TypeConverterAttribute

Undantag

DataException

Nyckeln är en sekundärnyckel.

Exempel

Det första exemplet visar hur du returnerar primärnyckelkolumnerna för en DataTable som visas i en DataGrid. Det andra exemplet visar hur du anger primärnyckelkolumnerna för en DataTable.

private void GetPrimaryKeys(DataTable table)
{
    // Create the array for the columns.
    DataColumn[] columns;
    columns = table.PrimaryKey;

    // Get the number of elements in the array.
    Console.WriteLine($"Column Count: {columns.Length}");
    for (int i = 0; i < columns.Length; i++)
    {
        Console.WriteLine($"{columns[i].ColumnName} {columns[i].DataType}");
    }
}

private void SetPrimaryKeys()
{
    // Create a new DataTable and set two DataColumn objects as primary keys.
    var table = new DataTable();
    var keys = new DataColumn[2];
    DataColumn column;

    // Create column 1.
    column = new DataColumn();
    column.DataType = Type.GetType("System.String");
    column.ColumnName= "FirstName";

    // Add the column to the DataTable.Columns collection.
    table.Columns.Add(column);

    // Add the column to the array.
    keys[0] = column;

    // Create column 2 and add it to the array.
    column = new DataColumn();
    column.DataType = Type.GetType("System.String");
    column.ColumnName = "LastName";
    table.Columns.Add(column);

    // Add the column to the array.
    keys[1] = column;

    // Set the PrimaryKeys property to the array.
    table.PrimaryKey = keys;
}

Private Sub GetPrimaryKeys(table As DataTable)
    ' Create the array for the columns.
    Dim columns As DataColumn()
    columns = table.PrimaryKey

    ' Get the number of elements in the array.
    Console.WriteLine($"Column Count: {columns.Length}")
    For i = 0 To columns.GetUpperBound(0)
        Console.WriteLine($"{columns(i).ColumnName} {columns(i).DataType}")
    Next
End Sub

Private Sub SetPrimaryKeys()
    ' Create a new DataTable and set two DataColumn objects as primary keys.
    Dim table As New DataTable()
    Dim keys(1) As DataColumn
    Dim column  As DataColumn

    ' Create column 1.
    column = New DataColumn()
    column.DataType = Type.GetType("System.String")
    column.ColumnName= "FirstName"

    ' Add the column to the DataTable.Columns collection.
    table.Columns.Add(column)
    ' Add the column to the array.
    keys(0) = column

    ' Create column 2 and add it to the array.
    column = New DataColumn()
    column.DataType = Type.GetType("System.String")
    column.ColumnName = "LastName"
    table.Columns.Add(column)

    ' Add the column to the array.
    keys(1) = column

    ' Set the PrimaryKeys property to the array.
    table.PrimaryKey = keys
End Sub

Kommentarer

Den primära nyckeln i en tabell måste vara unik för att identifiera posten i tabellen. Det går också att ha en tabell med en primärnyckel som består av två eller flera kolumner. Detta inträffar när en enskild kolumn inte kan innehålla tillräckligt med unika värden. En primärnyckel med två kolumner kan till exempel bestå av kolumnen "OrderNumber" och "ProductID". Eftersom primära nycklar kan bestå av mer än en kolumn PrimaryKey består egenskapen av en matris med DataColumn objekt.

Se även

• DataColumn
• PrimaryKey
• DataColumnCollection
• DataTables