DataColumn.ColumnName Propiedad

Definición

Obtiene o establece el nombre de la columna en el DataColumnCollection.Gets or sets the name of the column in the 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
Public Property ColumnName As String

Valor de propiedad

Nombre de la columna.The name of the column.

Atributos

Excepciones

La propiedad se establece en null o es una cadena vacía y la columna pertenece a una colección.The property is set to null or an empty string and the column belongs to a collection.

Ya existe una columna con el mismo nombre en la colección.A column with the same name already exists in the collection. La comparación de nombres no distingue entre mayúsculas y minúsculas.The name comparison is not case sensitive.

Ejemplos

En los ejemplos siguientes se obtiene el ColumnName para todas las columnas de todas las tablas de un DataSet.The following examples gets the ColumnName for every column in every table in a DataSet. En el ejemplo también se muestra cómo crear un DataColumn con un nuevo ColumnName.The example also shows how to create a DataColumn with a new 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

Comentarios

Cuando se crea un DataColumn, no tiene ningún valor ColumnName.When a DataColumn is created, it has no ColumnName value. Sin embargo, cuando se agrega el DataColumn a un DataColumnCollection para un objeto DataTable, se le asigna un nombre predeterminado ("Columna1", "Columna2", etc.).However, when the DataColumn is added to a DataColumnCollection for a DataTable object, it is given a default name ("Column1", "Column2", and so on).

De forma predeterminada, el valor Caption se establece en el valor ColumnName.By default, the Caption value is set to the ColumnName value.

Se aplica a

Consulte también: