DrawItemEventArgs.Index Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the index value of the item that is being drawn.

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

member Index : int with get

Property Value

Type: System.Int32

The numeric value that represents the Item value of the item being drawn.

This property returns the Item value of the item being drawn in the System.Windows.Forms.Control.ControlCollection. This property can return -1 if itemswere removed from the list.

The following example demonstrates how to create owner-drawn ListBox items. The code uses the DrawMode property to specify that the items drawn are a fixed size 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 named listBox1 was added to a form and that the DrawItem event is handled by the event handler that is defined in the example code. The example also assumes that items were 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
Available since 1.1
Return to top
Show: