.NET Framework Class Library
DataGridViewColumn..::.HeaderText Property

Gets or sets the caption text on the column's header cell.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
Syntax

Visual Basic (Declaration)
Public Property HeaderText As String
Visual Basic (Usage)
Dim instance As DataGridViewColumn
Dim value As String

value = instance.HeaderText

instance.HeaderText = value
C#
public string HeaderText { get; set; }
Visual C++
public:
property String^ HeaderText {
    String^ get ();
    void set (String^ value);
}
JScript
public function get HeaderText () : String
public function set HeaderText (value : String)

Property Value

Type: System..::.String
A String with the desired text. The default is an empty string ("").
Remarks

This property is useful only when the column has an associated header cell. For more information, see the HeaderCellCore property.

NoteNote:

There is no corresponding header text property for rows. To display labels in row headers, you must handle the DataGridView..::.CellPainting event and paint your own labels when DataGridViewCellPaintingEventArgs..::.ColumnIndex is -1.

Examples

The following code example uses the HeaderText property to change the text in the column header. This code example is part of a larger example provided for the DataGridViewColumn class.

Visual Basic
' Change the text in the column header.
Private Sub Button9_Click(ByVal sender As Object, _
    ByVal args As EventArgs) Handles Button9.Click

    For Each column As DataGridViewColumn _
        In dataGridView.Columns

        column.HeaderText = String.Concat("Column ", _
            column.Index.ToString)
    Next
End Sub
C#
// Change the text in the column header.
private void Button9_Click(object sender,
    EventArgs args)
{
    foreach (DataGridViewColumn column in dataGridView.Columns)
    {

        column.HeaderText = String.Concat("Column ",
            column.Index.ToString());
    }
}
Visual C++
// Change the text in the column header.
void Button9_Click( Object^ /*sender*/, EventArgs^ /*args*/ )
{
   IEnumerator^ myEnum2 = dataGridView->Columns->GetEnumerator();
   while ( myEnum2->MoveNext() )
   {
      DataGridViewColumn^ column = safe_cast<DataGridViewColumn^>(myEnum2->Current);
      column->HeaderText = String::Concat( L"Column ", column->Index.ToString() );
   }
}


Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0
See Also

Reference

Tags :


Page view tracker