DataGridColumnStyle.HeaderText Property

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the text of the column header.

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

public virtual string HeaderText { get; set; }

member this.HeaderText : string with get, set

Public Overridable Property HeaderText As String

Property Value

String

A string that is displayed as the column header. If it is created by the DataGrid, the default value is the name of the PropertyDescriptor used to create the column. If it is created by the user, the default is an empty string ("").

Examples

The following code example sets the HeaderText property to a new value.

void SetHeaderText()
{
   DataGridColumnStyle^ dgCol;
   DataColumn^ dataCol1;
   DataTable^ dataTable1;
   dgCol = dataGrid1->TableStyles[ 0 ]->GridColumnStyles[ 0 ];
   dataTable1 = dataSet1->Tables[ dataGrid1->DataMember ];
   dataCol1 = dataTable1->Columns[ dgCol->MappingName ];
   dgCol->HeaderText = dataCol1->Caption;
}

private void SetHeaderText()
{
    DataGridColumnStyle dgCol;
    DataColumn dataCol1;
    DataTable dataTable1;
    dgCol = dataGrid1.TableStyles[0].GridColumnStyles[0];
    dataTable1 = dataSet1.Tables[dataGrid1.DataMember];
    dataCol1 = dataTable1.Columns[dgCol.MappingName];
    dgCol.HeaderText = dataCol1.Caption;
}

Private Sub SetHeaderText()
    Dim dgCol As DataGridColumnStyle
    Dim dataCol1 As DataColumn
    Dim dataTable1 As DataTable
    dgCol = dataGrid1.TableStyles(0).GridColumnStyles(0)
    dataTable1 = dataSet1.Tables(dataGrid1.DataMember)
    dataCol1 = dataTable1.Columns(dgCol.MappingName)
    dgCol.HeaderText = dataCol1.Caption
End Sub

Remarks

The HeaderText property is typically used to display a caption that is different from the MappingName value when the MappingName value isn't easily understandable. For example, you can change the HeaderText to "First Name" when the MappingName value is "FName".

Applies to

Product	Versions
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop	3.0, 10

Share via