DrawItemEventArgs Class

Provides data for the DrawItem event.

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

type DrawItemEventArgs =  
    class 
        inherit EventArgs 
    end

The DrawItemEventArgs type exposes the following members.

  NameDescription
Public methodDrawItemEventArgs(Graphics, Font, Rectangle, Int32, DrawItemState)Initializes a new instance of the DrawItemEventArgs class for the specified control with the specified font, state, surface to draw on, and the bounds to draw within.
Public methodDrawItemEventArgs(Graphics, Font, Rectangle, Int32, DrawItemState, Color, Color)Initializes a new instance of the DrawItemEventArgs class for the specified control with the specified font, state, foreground color, background color, surface to draw on, and the bounds to draw within.
Top

  NameDescription
Public propertyBackColorGets the background color of the item that is being drawn.
Public propertyBoundsGets the rectangle that represents the bounds of the item that is being drawn.
Public propertyFontGets the font that is assigned to the item being drawn.
Public propertyForeColorGets the foreground color of the of the item being drawn.
Public propertyGraphicsGets the graphics surface to draw the item on.
Public propertyIndexGets the index value of the item that is being drawn.
Public propertyStateGets the state of the item being drawn.
Top

  NameDescription
Public methodDrawBackgroundDraws the background within the bounds specified in the DrawItemEventArgs constructor and with the appropriate color.
Public methodDrawFocusRectangleDraws a focus rectangle within the bounds specified in the DrawItemEventArgs constructor.
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.)
Top

The DrawItem event is raised by owner draw controls, such as the ListBox and ComboBox controls. It contains all the information that is needed for the user to paint the specified item, including the item index, the Rectangle, and the Graphics on which the drawing should be done.

The following example demonstrates how to create owner-drawn ListBox items. The code uses the DrawMode property to specify that the items drawn are fixed sized and the DrawItem event to perform the drawing of each item into the ListBox. The example code uses the properties and methods of the DrawItemEventArgs class passed as a parameter to the event handler to draw the items. This example assumes that a ListBox control that is named listBox1 has been added to a form and that the DrawItem event is handled by the event handler defined in the example code. The example also assumes that items have been added to the ListBox with the text of "Apple", "Orange", and "Plum" in that order.

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

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft