Export (0) Print
Expand All

ListViewItem Class

Represents an item in a ListView control.

System.Object
  System.Windows.Forms.ListViewItem

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

[<SerializableAttribute>]
[<TypeConverterAttribute(typeof(ListViewItemConverter))>]
type ListViewItem =  
    class 
        interface ICloneable 
        interface ISerializable 
    end

The ListViewItem type exposes the following members.

  NameDescription
Public methodListViewItem()Initializes a new instance of the ListViewItem class with default values.
Public methodListViewItem(ListViewGroup)Initializes a new instance of the ListViewItem class and assigns it to the specified group.
Public methodListViewItem(String)Initializes a new instance of the ListViewItem class with the specified item text.
Public methodListViewItem(String[])Initializes a new instance of the ListViewItem class with an array of strings representing subitems.
Public methodListViewItem(ListViewItem.ListViewSubItem[], Int32)Initializes a new instance of the ListViewItem class with the image index position of the item's icon and an array of ListViewItem.ListViewSubItem objects.
Public methodListViewItem(ListViewItem.ListViewSubItem[], String)Initializes a new instance of the ListViewItem class with the specified subitems and image.
Protected methodListViewItem(SerializationInfo, StreamingContext)Initializes a new instance of the ListViewItem class with the specified serialization information and streaming context.
Public methodListViewItem(String, Int32)Initializes a new instance of the ListViewItem class with the specified item text and the image index position of the item's icon.
Public methodListViewItem(String, String)Initializes a new instance of the ListViewItem class with the specified text and image.
Public methodListViewItem(String, ListViewGroup)Initializes a new instance of the ListViewItem class with the specified item text and assigns it to the specified group.
Public methodListViewItem(String[], Int32)Initializes a new instance of the ListViewItem class with the image index position of the item's icon and an array of strings representing subitems.
Public methodListViewItem(String[], String)Initializes a new instance of the ListViewItem class with the specified item and subitem text and image.
Public methodListViewItem(String[], ListViewGroup)Initializes a new instance of the ListViewItem class with an array of strings representing subitems, and assigns the item to the specified group.
Public methodListViewItem(ListViewItem.ListViewSubItem[], Int32, ListViewGroup)Initializes a new instance of the ListViewItem class with the image index position of the item's icon and an array of ListViewItem.ListViewSubItem objects, and assigns the item to the specified group.
Public methodListViewItem(ListViewItem.ListViewSubItem[], String, ListViewGroup)Initializes a new instance of the ListViewItem class with the specified subitems, image, and group.
Public methodListViewItem(String, Int32, ListViewGroup)Initializes a new instance of the ListViewItem class with the specified item text and the image index position of the item's icon, and assigns the item to the specified group.
Public methodListViewItem(String, String, ListViewGroup)Initializes a new instance of the ListViewItem class with the specified text, image, and group.
Public methodListViewItem(String[], Int32, ListViewGroup)Initializes a new instance of the ListViewItem class with the image index position of the item's icon and an array of strings representing subitems, and assigns the item to the specified group.
Public methodListViewItem(String[], String, ListViewGroup)Initializes a new instance of the ListViewItem class with subitems containing the specified text, image, and group.
Public methodListViewItem(String[], Int32, Color, Color, Font)Initializes a new instance of the ListViewItem class with the image index position of the item's icon; the foreground color, background color, and font of the item; and an array of strings representing subitems.
Public methodListViewItem(String[], String, Color, Color, Font)Initializes a new instance of the ListViewItem class with the subitems containing the specified text, image, colors, and font.
Public methodListViewItem(String[], Int32, Color, Color, Font, ListViewGroup)Initializes a new instance of the ListViewItem class with the image index position of the item's icon; the foreground color, background color, and font of the item; and an array of strings representing subitems. Assigns the item to the specified group.
Public methodListViewItem(String[], String, Color, Color, Font, ListViewGroup)Initializes a new instance of the ListViewItem class with the subitems containing the specified text, image, colors, font, and group.
Top

  NameDescription
Public propertyBackColorGets or sets the background color of the item's text.
Public propertyBoundsGets the bounding rectangle of the item, including subitems.
Public propertyCheckedGets or sets a value indicating whether the item is checked.
Public propertyFocusedGets or sets a value indicating whether the item has focus within the ListView control.
Public propertyFontGets or sets the font of the text displayed by the item.
Public propertyForeColorGets or sets the foreground color of the item's text.
Public propertyGroupGets or sets the group to which the item is assigned.
Public propertyImageIndexGets or sets the index of the image that is displayed for the item.
Public propertyImageKeyGets or sets the key for the image that is displayed for the item.
Public propertyImageListGets the ImageList that contains the image displayed with the item.
Public propertyIndentCountGets or sets the number of small image widths by which to indent the ListViewItem.
Public propertyIndexGets the zero-based index of the item within the ListView control.
Public propertyListViewGets the ListView control that contains the item.
Public propertyNameGets or sets the name associated with this ListViewItem.
Public propertyPositionGets or sets the position of the upper-left corner of the ListViewItem.
Public propertySelectedGets or sets a value indicating whether the item is selected.
Public propertyStateImageIndexGets or sets the index of the state image (an image such as a selected or cleared check box that indicates the state of the item) that is displayed for the item.
Public propertySubItemsGets a collection containing all subitems of the item.
Public propertyTagGets or sets an object that contains data to associate with the item.
Public propertyTextGets or sets the text of the item.
Public propertyToolTipTextGets or sets the text shown when the mouse pointer rests on the ListViewItem.
Public propertyUseItemStyleForSubItemsGets or sets a value indicating whether the Font, ForeColor, and BackColor properties for the item are used for all its subitems.
Top

  NameDescription
Public methodBeginEditPlaces the item text into edit mode.
Public methodCloneCreates an identical copy of the item.
Protected methodDeserializeDeserializes the item.
Public methodEnsureVisibleEnsures that the item is visible within the control, scrolling the contents of the control, if necessary.
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 methodFindNearestItemFinds the next item from the ListViewItem, searching in the specified direction.
Public methodGetBoundsRetrieves the specified portion of the bounding rectangle for the item.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetSubItemAtReturns the subitem of the ListViewItem at the specified coordinates.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRemoveRemoves the item from its associated ListView control.
Protected methodSerializeSerializes the item.
Public methodToStringReturns a string that represents the current object. (Overrides Object.ToString().)
Top

The ListView control is similar to a ListBox in that it displays a list of items. The main difference is that the ListView control provides a number of different ways items can be viewed by the user. The ListViewItem class defines the appearance, behavior, and data associated with an item that is displayed in the ListView control. ListViewItem objects can be displayed in the ListView control in one of four different views. Items can be displayed as large or small icons or as small icons in a vertical list. Items can also have subitems that contain information that is related to the parent item. The fourth view style, details view, allows you to display the item and its subitems in a grid with column headers that can be used to identify the information being displayed in a subitem.

Most of the properties of the ListViewItem class provide ways to change the display of the item in the ListView control it is associated with. The BackColor, ForeColor, and Font properties allow you to change how the text of the item is displayed in the ListView control. The ImageIndex property allows you to specify the image to load from the ImageList that is assigned to the ListView control (by setting the LargeImageList or SmallImageList properties of the ListView). Items can display check boxes in order to obtain item choices from the user in a way similar to a CheckedListBox control. You can use the Checked property to determine if an item is checked, or to select or clear the check box at run time. Items can display any number of subitems when the View property of the associated ListView control is set to Details and columns are defined in the ListView.ColumnHeaderCollection of the ListView control. You can add subitems to an item by calling the Add method of the ListViewItem.ListViewSubItemCollection class. The SubItems property allows you to gain access to the ListViewItem.ListViewSubItemCollection class and its members.

Some of the properties and methods of the ListViewItem class are item-specific versions of properties and methods in the ListView control. For example, the EnsureVisible method is similar to the ListView version of the method, but the ListViewItem version affects only the current item.

The ListViewItem class also provides methods that are not versions of ListView methods. The BeginEdit method places the item's text into edit mode so the user can change the item's text (when the LabelEdit property of the ListView control is set to true). The Clone method allows you to create copies of existing ListViewItem objects to reuse in other ListView controls.

The following code example creates a ListView control with three ListViewItem objects specified and three ListViewItem.ListViewSubItem objects specified for each item. The example also creates ColumnHeader objects to display the subitems in details view. Two ImageList objects are also created in the code example to provide images for the ListViewItem objects. These ImageList objects are added to the LargeImageList and SmallImageList properties. The example uses the following properties in creating the ListView control:

You need to add the code to a Form and call the method created in the example from the constructor or another method on the form. The example requires that images named MySmallImage1, MySmallImage2, MyLargeImage1, and MyLargeImage2 are located in the root directory of drive C.

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.
Show:
© 2014 Microsoft