Edit

Share via

ListView.DrawColumnHeader Event

  • Reference

Definition

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

Occurs when the details view of a ListView is drawn and the OwnerDraw property is set to true.

public:
 event System::Windows::Forms::DrawListViewColumnHeaderEventHandler ^ DrawColumnHeader;
public event System.Windows.Forms.DrawListViewColumnHeaderEventHandler DrawColumnHeader;
public event System.Windows.Forms.DrawListViewColumnHeaderEventHandler? DrawColumnHeader;
member this.DrawColumnHeader : System.Windows.Forms.DrawListViewColumnHeaderEventHandler 
Public Custom Event DrawColumnHeader As DrawListViewColumnHeaderEventHandler

Event Type

DrawListViewColumnHeaderEventHandler

Examples

The following code example provides an implementation of a DrawColumnHeader event handler. For the complete example, including the implementation of the DrawSubItem event handler, see the OwnerDraw reference topic.

// Draws column headers.
private void listView1_DrawColumnHeader(object sender,
    DrawListViewColumnHeaderEventArgs e)
{
    using (StringFormat sf = new StringFormat())
    {
        // Store the column text alignment, letting it default
        // to Left if it has not been set to Center or Right.
        switch (e.Header.TextAlign)
        {
            case HorizontalAlignment.Center:
                sf.Alignment = StringAlignment.Center;
                break;
            case HorizontalAlignment.Right:
                sf.Alignment = StringAlignment.Far;
                break;
        }

        // Draw the standard header background.
        e.DrawBackground();

        // Draw the header text.
        using (Font headerFont =
                    new Font("Helvetica", 10, FontStyle.Bold))
        {
            e.Graphics.DrawString(e.Header.Text, headerFont,
                Brushes.Black, e.Bounds, sf);
        }
    }
    return;
}

' Draws column headers.
Private Sub listView1_DrawColumnHeader(ByVal sender As Object, _
    ByVal e As DrawListViewColumnHeaderEventArgs) _
    Handles listView1.DrawColumnHeader

    Dim sf As New StringFormat()
    Try

        ' Store the column text alignment, letting it default
        ' to Left if it has not been set to Center or Right.
        Select Case e.Header.TextAlign
            Case HorizontalAlignment.Center
                sf.Alignment = StringAlignment.Center
            Case HorizontalAlignment.Right
                sf.Alignment = StringAlignment.Far
        End Select

        ' Draw the standard header background.
        e.DrawBackground()

        ' Draw the header text.
        Dim headerFont As New Font("Helvetica", 10, FontStyle.Bold)
        Try
            e.Graphics.DrawString(e.Header.Text, headerFont, _
                Brushes.Black, e.Bounds, sf)
        Finally
            headerFont.Dispose()
        End Try

    Finally
        sf.Dispose()
    End Try

End Sub

Remarks

This event lets you customize the appearance of a ListView control using owner drawing. It is raised only when the OwnerDraw property is set to true and the View property is set to View.Details. This event can occur for each column header in the control. For more information on owner drawing, see the OwnerDraw property reference topic.

For more information about handling events, see Handling and Raising Events.

Applies to

See also