DataColumn.ColumnName Propriedade

  • Referência

Definição

Namespace:
System.Data
Assembly:
System.Data.Common.dll
Assembly:
System.Data.dll
Assembly:
netstandard.dll
Origem:
DataColumn.cs
Origem:
DataColumn.cs
Origem:
DataColumn.cs

Obtém ou define o nome da coluna no DataColumnCollection.

public:
 property System::String ^ ColumnName { System::String ^ get(); void set(System::String ^ value); };
public string ColumnName { get; set; }
[System.Data.DataSysDescription("DataColumnColumnNameDescr")]
public string ColumnName { get; set; }
member this.ColumnName : string with get, set
[<System.Data.DataSysDescription("DataColumnColumnNameDescr")>]
member this.ColumnName : string with get, set
Public Property ColumnName As String

Valor da propriedade

String

O nome da coluna.

Atributos
DataSysDescriptionAttribute

Exceções

ArgumentException

A propriedade é definida como null ou com uma cadeia de caracteres vazia e a coluna pertence a uma coleção.

DuplicateNameException

Uma coluna com o mesmo nome já existe na coleção. A comparação de nomes não diferencia maiúsculas de minúsculas.

Exemplos

Os exemplos a seguir obtém o ColumnName para cada coluna em cada tabela em um DataSet. O exemplo também mostra como criar um DataColumn com um novo 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

Comentários

Quando um DataColumn é criado, ele não tem nenhum ColumnName valor. No entanto, quando o DataColumn é adicionado a um DataColumnCollection para um DataTable objeto , ele recebe um nome padrão ("Column1", "Column2" e assim por diante).

Por padrão, o Caption valor é definido como o ColumnName valor .

Aplica-se a

Confira também