DataTable.PrimaryKey Tulajdonság

Definíció

Névtér:

System.Data

Szerelvények:

netstandard.dll, System.Data.Common.dll

Forrás:

DataTable.cs

Lekéri vagy beállít egy oszloptömböt, amely az adattábla elsődleges kulcsaként működik.

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()

Tulajdonság értéke

DataColumn[]

Objektumok tömbje DataColumn .

Attribútumok

TypeConverterAttribute

Kivételek

DataException

A kulcs egy idegen kulcs.

Példák

Az első példa bemutatja, hogyan lehet visszaadni az elsődleges kulcs oszlopait egy DataTable .DataGrid A második példa bemutatja, hogyan állíthatja be az elsődleges kulcsoszlopokat egy 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

Megjegyzések

A tábla elsődleges kulcsának egyedinek kell lennie a tábla rekordjának azonosításához. Két vagy több oszlopból álló elsődleges kulccsal rendelkező tábla is lehet. Ez akkor fordul elő, ha egyetlen oszlop nem tud elegendő egyedi értéket tartalmazni. Egy kétoszlopos elsődleges kulcs például egy "OrderNumber" és "ProductID" oszlopból állhat. Mivel az elsődleges kulcsok több oszlopból is alkothatók, a PrimaryKey tulajdonság objektumtömbből DataColumn áll.

Lásd még

• DataColumn
• PrimaryKey
• DataColumnCollection
• DataTables