DataColumn.ColumnName Propriété

Définition

Espace de noms:

System.Data

Assembly:

System.Data.Common.dll

Source:

DataColumn.cs

Obtient ou définit le nom de la colonne dans le DataColumnCollection.

public:
 property System::String ^ ColumnName { System::String ^ get(); void set(System::String ^ value); };

public string ColumnName { get; set; }

member this.ColumnName : string with get, set

Public Property ColumnName As String

Valeur de propriété

String

Nom de la colonne.

Exceptions

ArgumentException

La valeur null ou une chaîne vide est affectée à la propriété et la colonne appartient à une collection.

DuplicateNameException

Une colonne portant le même nom existe déjà dans la collection. La comparaison des noms ne respecte pas la casse.

Exemples

Les exemples suivants obtiennent le ColumnName pour chaque colonne de chaque table d’un DataSet. L’exemple montre également comment créer un DataColumn avec un nouveau ColumnName.

private void PrintColumnNames(DataSet dataSet)
{
    // For each DataTable, print the ColumnName.
    foreach(DataTable table in dataSet.Tables)
    {
        foreach(DataColumn column in table.Columns)
        {
            Console.WriteLine(column.ColumnName);
        }
    }
}

private void AddColumn(DataTable table)
{
    DataColumn column;
    column = new DataColumn();
    column.ColumnName = "SupplierID";
    column.DataType = System.Type.GetType("System.String");
    column.Unique = true;
    column.AutoIncrement = false;
    column.Caption = "SupplierID";
    column.ReadOnly = false;

    // Add the column to the table's columns collection.
    table.Columns.Add(column);
}

Private Sub PrintColumnNames(dataSet As DataSet)
    Dim table As DataTable
    Dim column As DataColumn 

    ' For each DataTable, print the ColumnName.
    For Each table in dataSet.Tables
        For Each column in table.Columns
        Console.WriteLine(column.ColumnName)
        Next
    Next
End Sub

Private Sub AddColumn(table As DataTable)
    Dim column As DataColumn
    column = New DataColumn()

    With column
        .ColumnName = "SupplierID"
        .DataType = System.Type.GetType("System.String")
        .Unique = True
        .AutoIncrement = False
        .Caption = "SupplierID"
        .ReadOnly = False
    End With

    ' Add the column to the table's columns collection.
    table.Columns.Add(column)
End Sub

Remarques

Lorsqu’un DataColumn est créé, il n’a aucune ColumnName valeur. Toutefois, lorsque le DataColumn est ajouté à un DataColumnCollection pour un DataTable objet, un nom par défaut lui est attribué (« Column1 », « Column2 », etc.).

Par défaut, la Caption valeur est définie sur la ColumnName valeur .

Voir aussi

• Caption
• Utilisation de DataSets dans ADO.NET