Export (0) Print
Expand All

ListView.DrawSubItem Event

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

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

public event DrawListViewSubItemEventHandler DrawSubItem

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. For more information on owner drawing, see the OwnerDraw property reference topic.

NoteNote

Subitem information typically appears in the tile view as well as the details view, but in the tile view, it must be drawn in a handler for the DrawItem event.

The DrawSubItem event can occur for each ListView subitem. You can handle the DrawItem event to draw elements common to all subitems, such as the background, and handle the DrawSubItem event to draw elements for individual subitems, such as text values. You can also draw all items in the ListView control using only one of the two events, although this may be less convenient. To draw column headers in the details view, you must handle the DrawColumnHeader event.

NoteNote

The DrawSubItem event does not occur for any subitems for which no ColumnHeader object has been added to the Columns collection. Note also that the first subitem of each ListViewItem object represents the parent item itself, and is displayed in the first column.

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

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

// Draws subitem text and applies content-based formatting. 
private void listView1_DrawSubItem(object sender,
    DrawListViewSubItemEventArgs e)
{
    TextFormatFlags flags = TextFormatFlags.Left;

    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;
                flags = TextFormatFlags.HorizontalCenter;
                break;
            case HorizontalAlignment.Right:
                sf.Alignment = StringAlignment.Far;
                flags = TextFormatFlags.Right;
                break;
        }

        // Draw the text and background for a subitem with a  
        // negative value.  
        double subItemValue;
        if (e.ColumnIndex > 0 && Double.TryParse(
            e.SubItem.Text, NumberStyles.Currency,
            NumberFormatInfo.CurrentInfo, out subItemValue) &&
            subItemValue < 0)
        {
            // Unless the item is selected, draw the standard  
            // background to make it stand out from the gradient. 
            if ((e.ItemState & ListViewItemStates.Selected) == 0)
            {
                e.DrawBackground();
            }

            // Draw the subitem text in red to highlight it. 
            e.Graphics.DrawString(e.SubItem.Text,
                listView1.Font, Brushes.Red, e.Bounds, sf);

            return;
        }

        // Draw normal text for a subitem with a nonnegative  
        // or nonnumerical value.
        e.DrawText(flags);
    }
}

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft