0 out of 1 rated this helpful - Rate this topic

ListViewItem.Tag Property

.NET Framework 4

Other Versions

Gets or sets an object that contains data to associate with the item.

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

Syntax

C++

Copy

[BindableAttribute(true)]
[TypeConverterAttribute(typeof(StringConverter))]
public Object Tag { get; set; }

Property Value

Type: System.Object
An object that contains information that is associated with the item.

Remarks

The Tag property can be used to store any object that you want to associate with an item. Although you can store any item, the Tag property is typically used to store string information about the item, such as a unique identifier or the index position of the item's data in a database.

Examples

The following code example demonstrates how to initialize a ListViewItem and set the Tag and Text properties. To run this example, place the following code in a form that contains a ListView named ListView1, and call InitializeListViewItems from the form's constructor or Load event-handling method.

C++

Copy


	private void InitializeListViewItems()
	{
		ListView1.View = View.List;
		

		Cursor[] favoriteCursors = new Cursor[]{Cursors.Help, 
			Cursors.Hand, Cursors.No, Cursors.Cross};

		// Populate the ListView control with the array of Cursors.
		foreach ( Cursor aCursor in favoriteCursors )
		{

			// Construct the ListViewItem object
			ListViewItem item = new ListViewItem();

			// Set the Text property to the cursor name.
			item.Text = aCursor.ToString();

			// Set the Tag property to the cursor.
			item.Tag = aCursor;

			// Add the ListViewItem to the ListView.
			ListView1.Items.Add(item);
		}
	}

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

ListViewItem Class

System.Windows.Forms Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ