DrawListViewItemEventArgs Class

 

Provides data for the ListView.DrawItem event.

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

System.Object
  System.EventArgs
    System.Windows.Forms.DrawListViewItemEventArgs

type DrawListViewItemEventArgs = 
    class
        inherit EventArgs
    end

NameDescription
System_CAPS_pubmethodDrawListViewItemEventArgs(Graphics, ListViewItem, Rectangle, Int32, ListViewItemStates)

Initializes a new instance of the DrawListViewItemEventArgs class.

NameDescription
System_CAPS_pubpropertyBounds

Gets the size and location of the ListViewItem to draw.

System_CAPS_pubpropertyDrawDefault

Gets or sets a property indicating whether the ListView control will use the default drawing for the ListViewItem.

System_CAPS_pubpropertyGraphics

Gets the Graphics used to draw the ListViewItem.

System_CAPS_pubpropertyItem

Gets the ListViewItem to draw.

System_CAPS_pubpropertyItemIndex

Gets the index of the ListViewItem within the Items collection of the containing ListView.

System_CAPS_pubpropertyState

Gets the current state of the ListViewItem to draw.

NameDescription
System_CAPS_pubmethodDrawBackground()

Draws the background of the ListViewItem using its current background color.

System_CAPS_pubmethodDrawFocusRectangle()

Draws a focus rectangle for the ListViewItem if it has focus.

System_CAPS_pubmethodDrawText()

Draws the text of the ListViewItem using its current foreground color.

System_CAPS_pubmethodDrawText(TextFormatFlags)

Draws the text of the ListViewItem using its current foreground color and formatting it with the specified TextFormatFlags values.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

The ListView.DrawItem event enables you to customize the appearance of a ListView control using owner drawing.

The ListView.DrawItem event is raised by a ListView control when the ListView.OwnerDraw property is set to true. The DrawListViewItemEventArgs passed to the event handler contains information about the ListViewItem to draw and also provides methods to help you draw the item.

Use the State or Item properties to retrieve information about the item to draw. Use the DrawListViewItemEventArgs.ItemIndex property to retrieve the index of the item.

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.

System_CAPS_noteNote

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
Available since 2.0

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

Return to top
Show: