This documentation is archived and is not being maintained.

ToolStripLabel Class

Represents a nonselectable ToolStripItem that renders text and images and can display hyperlinks.

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

'Declaration
<ToolStripItemDesignerAvailabilityAttribute(ToolStripItemDesignerAvailability.ToolStrip)> _
Public Class ToolStripLabel _
	Inherits ToolStripItem
'Usage
Dim instance As ToolStripLabel

Use the ToolStripLabel class to create a label that can render text and images that can implement the ToolStripItem.TextAlign and ToolStripItem.ImageAlign properties. The ToolStripLabel also has many properties that enable it to display one or more hyperlinks, and other properties that modify the appearance and behavior of hyperlinks.

The ToolStripLabel is like a ToolStripButton that does not get focus by default and that does not render as pushed or highlighted.

ToolStripLabel as a hosted item supports access keys.

Use the LinkColor, LinkVisited, and LinkBehavior properties on a ToolStripLabel to support link control in a ToolStrip.

The following code example demonstrates how to initialize a ToolStripLabel to contain a link by setting the IsLink, LinkColor, ActiveLinkColor, VisitedLinkColor, LinkVisited and LinkBehavior properties.

Imports System
Imports System.Collections.Generic
Imports System.ComponentModel
Imports System.Data
Imports System.Drawing
Imports System.Text
Imports System.Windows.Forms

Public Class Form1
   Inherits Form
   Private WithEvents toolStripLabel1 As ToolStripLabel
   Private toolStrip1 As ToolStrip

   Public Sub New()
      InitializeComponent()
   End Sub

   <STAThread()>  _
   Shared Sub Main()
      Application.EnableVisualStyles()
      Application.SetCompatibleTextRenderingDefault(False)
      Application.Run(New Form1())
   End Sub 


   Private Sub InitializeComponent()
      Me.toolStrip1 = New System.Windows.Forms.ToolStrip()
      Me.toolStripLabel1 = New System.Windows.Forms.ToolStripLabel()
      Me.toolStrip1.SuspendLayout()
      Me.SuspendLayout()
      '  
      ' toolStrip1 
      '  
      Me.toolStrip1.Items.AddRange(New System.Windows.Forms.ToolStripItem() {Me.toolStripLabel1})
      Me.toolStrip1.Location = New System.Drawing.Point(0, 0)
      Me.toolStrip1.Name = "toolStrip1" 
      Me.toolStrip1.Size = New System.Drawing.Size(292, 25)
      Me.toolStrip1.TabIndex = 0
      Me.toolStrip1.Text = "toolStrip1" 
      '  
      ' toolStripLabel1 
      '  
      Me.toolStripLabel1.IsLink = True 
      Me.toolStripLabel1.LinkBehavior = System.Windows.Forms.LinkBehavior.AlwaysUnderline
      Me.toolStripLabel1.Name = "toolStripLabel1" 
      Me.toolStripLabel1.Size = New System.Drawing.Size(71, 22)
      Me.toolStripLabel1.Tag = "http://search.microsoft.com/search/search.aspx?" 
      Me.toolStripLabel1.Text = "Search MSDN" 
      '  
      ' Form1 
      '  
      Me.ClientSize = New System.Drawing.Size(292, 273)
      Me.Controls.Add(toolStrip1)
      Me.Name = "Form1" 
      Me.toolStrip1.ResumeLayout(False)
      Me.toolStrip1.PerformLayout()
      Me.ResumeLayout(False)
      Me.PerformLayout()
   End Sub 


   Private Sub toolStripLabel1_Click(sender As Object, e As EventArgs) Handles toolStripLabel1.Click
      Dim toolStripLabel1 As ToolStripLabel = CType(sender, ToolStripLabel)

      ' Start Internet Explorer and navigate to the URL in the 
      ' tag property.
      System.Diagnostics.Process.Start("IEXPLORE.EXE", toolStripLabel1.Tag.ToString())

      ' Set the LinkVisited property to true to change the color.
      toolStripLabel1.LinkVisited = True 
   End Sub 
End Class

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: