ListView.ShowItemToolTips Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

ListView.cs

Gets or sets a value indicating whether ToolTips are shown for the ListViewItem objects contained in the ListView.

public:
 property bool ShowItemToolTips { bool get(); void set(bool value); };

public bool ShowItemToolTips { get; set; }

member this.ShowItemToolTips : bool with get, set

Public Property ShowItemToolTips As Boolean

Property Value

Boolean

true if ListViewItem ToolTips should be shown; otherwise, false. The default is true.

Examples

The following code example demonstrates how to use the ShowItemToolTips and ListViewItem.ToolTipText properties. To run this example, paste the code into a Windows Form and call InitializeItemsWithToolTips from the form's constructor or Load event handler.

// Declare the ListView.
private ListView ListViewWithToolTips;
private void InitializeItemsWithToolTips()
{

    // Construct and set the View property of the ListView.
    ListViewWithToolTips = new ListView();
    ListViewWithToolTips.Width = 200;
    ListViewWithToolTips.View = View.List;

    // Show item tooltips.
    ListViewWithToolTips.ShowItemToolTips = true;
    
    // Create items with a tooltip.
    ListViewItem item1WithToolTip = new ListViewItem("Item with a tooltip");
    item1WithToolTip.ToolTipText = "This is the item tooltip.";
    ListViewItem item2WithToolTip = new ListViewItem("Second item with a tooltip");
    item2WithToolTip.ToolTipText = "A different tooltip for this item.";

    // Create an item without a tooltip.
    ListViewItem itemWithoutToolTip = new ListViewItem("Item without tooltip.");

    // Add the items to the ListView.
    ListViewWithToolTips.Items.AddRange(new ListViewItem[]{item1WithToolTip, 
        item2WithToolTip, itemWithoutToolTip} );

    // Add the ListView to the form.
    this.Controls.Add(ListViewWithToolTips);
    this.Controls.Add(button1);
}

' Declare the ListView.
Private ListViewWithToolTips As ListView

Private Sub InitializeItemsWithToolTips() 
    
    ' Construct and set the View property of the ListView.
    ListViewWithToolTips = New ListView()
    ListViewWithToolTips.Width = 200
    ListViewWithToolTips.View = View.List
    
    ' Show item tooltips.
    ListViewWithToolTips.ShowItemToolTips = True
    
    ' Create items with a tooltip.
    Dim item1WithToolTip As New ListViewItem("Item with a tooltip")
    item1WithToolTip.ToolTipText = "This is the item tooltip."
    Dim item2WithToolTip As New ListViewItem("Second item with a tooltip")
    item2WithToolTip.ToolTipText = "A different tooltip for this item."
    
    ' Create an item without a tooltip.
    Dim itemWithoutToolTip As New ListViewItem("Item without tooltip.")
    
    ' Add the items to the ListView.
    ListViewWithToolTips.Items.AddRange(New ListViewItem() _
        {item1WithToolTip, item2WithToolTip, itemWithoutToolTip})
    
    ' Add the ListView to the form.
    Me.Controls.Add(ListViewWithToolTips)
    Me.Controls.Add(button1)

End Sub

Remarks

If the ShowItemToolTips property is set to true, any ListViewItem that has a ToolTip will display it; otherwise, nothing is displayed.