Export (0) Print
Expand All

DrawListViewSubItemEventArgs Class

Provides data for the ListView.DrawSubItem event.


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

type DrawListViewSubItemEventArgs =  
        inherit EventArgs 

The DrawListViewSubItemEventArgs type exposes the following members.

Public methodDrawListViewSubItemEventArgsInitializes a new instance of the DrawListViewSubItemEventArgs class.

Public propertyBoundsGets the size and location of the ListViewItem.ListViewSubItem to draw.
Public propertyColumnIndexGets the index of the ListView column in which the ListViewItem.ListViewSubItem is displayed.
Public propertyDrawDefaultGets or sets a value indicating whether the ListViewItem.ListViewSubItem should be drawn by the operating system instead of owner-drawn.
Public propertyGraphicsGets the Graphics used to draw the ListViewItem.ListViewSubItem.
Public propertyHeaderGets the header of the ListView column in which the ListViewItem.ListViewSubItem is displayed.
Public propertyItemGets the parent ListViewItem of the ListViewItem.ListViewSubItem to draw.
Public propertyItemIndexGets the index of the parent ListViewItem of the ListViewItem.ListViewSubItem to draw.
Public propertyItemStateGets the current state of the parent ListViewItem of the ListViewItem.ListViewSubItem to draw.
Public propertySubItemGets the ListViewItem.ListViewSubItem to draw.

Public methodDrawBackgroundDraws the background of the ListViewItem.ListViewSubItem using its current background color.
Public methodDrawFocusRectangleDraws a focus rectangle for the ListViewItem.ListViewSubItem if the parent ListViewItem has focus.
Public methodDrawText()Draws the text of the ListViewItem.ListViewSubItem using its current foreground color.
Public methodDrawText(TextFormatFlags)Draws the text of the ListViewItem.ListViewSubItem using its current foreground color and formatting it with the specified TextFormatFlags values.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The ListView.DrawSubItem event enables you to customize (or owner-draw) the appearance of a ListView control in the details view.

The ListView.DrawSubItem event is raised by a ListView control when its ListView.OwnerDraw property is set to true and its View property is set to Details. The DrawListViewSubItemEventArgs passed to the event handler contains information about the ListViewItem.ListViewSubItem to draw and also provides methods to help you draw the subitem.

Use the ItemState or Item properties to retrieve information about the parent item of the subitem to draw. To retrieve the ListViewItem.ListViewSubItem itself, use the SubItem property. Use the Header property to retrieve the ColumnHeader representing the header of the column in which the subitem is displayed.

Use the Graphics property to do the actual drawing within the area specified by the Bounds property. To draw standard ListView elements that do not need customization, use the DrawBackground, DrawText, and DrawFocusRectangle methods.

Use the DrawDefault property when you want the operating system to draw the subitem. This is useful when you want to customize only specific subitems.


To avoid issues with graphics flickering when owner drawing, override the ListView control and set the DoubleBuffered property to true. This feature is available only on Windows XP and the Windows Server 2003 family when your application calls the Application.EnableVisualStyles method.

The following code example demonstrates how to provide custom drawing for a ListView control. The ListView control in the example has a gradient background. Subitems with negative values have a red foreground and a black background.

A handler for the ListView.DrawItem event draws the background for entire items. A handler for the ListView.DrawSubItem event draws the text values and both the text and background for subitems that have negative values. A handler for the DrawColumnHeader event draws each column header.

A ContextMenu component provides a way to switch between the details view and the list view. In the list view, only the ListView.DrawItem event is fired. In this case, the text and background are both drawn in the ListView.DrawItem event handler.

No code example is currently available or this language may not be supported.

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
© 2015 Microsoft