Caption Property

DataColumn.Caption Property


Gets or sets the caption for the column.

Namespace:   System.Data
Assembly:  System.Data (in System.Data.dll)

public string Caption { get; set; }

Property Value

Type: System.String

The caption of the column. If not set, returns the ColumnName value.

You can use the Caption property to display a descriptive or friendly name for a DataColumn.

The following example creates a new DataTable. It then adds three DataColumn objects to a DataColumnCollection and sets the Caption property for each DataColumn.

private void CreateDataTable()
   DataTable table;
   DataColumn column;

   table = new DataTable("Customers");

   //CustomerID column
   column = table.Columns.Add("CustomerID", 
   column.Unique = true;

   //CustomerName column
   column = table.Columns.Add("CustomerName", 
   column.Caption = "Name";

   column = table.Columns.Add("CreditLimit", 
   column.DefaultValue = 0;
   column.Caption = "Limit";

   table.Rows.Add(new object[] {1, "Jonathan", 23.44});
   table.Rows.Add(new object[] {2, "Bill", 56.87});

.NET Framework
Available since 1.1
Return to top
© 2015 Microsoft