Export (0) Print
Expand All

LinkLabel.Link Class

Represents a link within a LinkLabel control.

System.Object
  System.Windows.Forms.LinkLabel.Link

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

[TypeConverterAttribute(typeof(LinkConverter))]
public class Link

The LinkLabel.Link type exposes the following members.

  NameDescription
Public methodLinkLabel.Link()Initializes a new instance of the LinkLabel.Link class.
Public methodLinkLabel.Link(Int32, Int32)Initializes a new instance of the LinkLabel.Link class with the specified starting location and number of characters after the starting location within the LinkLabel.
Public methodLinkLabel.Link(Int32, Int32, Object)Initializes a new instance of the LinkLabel.Link class with the specified starting location, number of characters after the starting location within the LinkLabel, and the data associated with the link.
Top

  NameDescription
Public propertyDescriptionGets or sets a text description of the link.
Public propertyEnabledGets or sets a value indicating whether the link is enabled.
Public propertyLengthGets or sets the number of characters in the link text.
Public propertyLinkDataGets or sets the data associated with the link.
Public propertyNameGets or sets the name of the LinkLabel.Link.
Public propertyStartGets or sets the starting location of the link within the text of the LinkLabel.
Public propertyTagGets or sets the object that contains data about the LinkLabel.Link.
Public propertyVisitedGets or sets a value indicating whether the user has visited the link.
Top

  NameDescription
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 methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The LinkLabel.Link class defines the properties of a link within a LinkLabel control. You can use these properties to provide data to the LinkClicked event of the LinkLabel control to perform tasks when the link is clicked in the control. The LinkData property enables you to define information that the LinkClicked event can use to display a URL within Microsoft Internet Explorer or to open a file.

In addition to information related to the link, the properties of the LinkLabel.Link class also help define the text of the LinkLabel.Link and its display state. The Start and Length properties define the location and length of text from the text of the LinkLabel control to display as a link. The Enabled property allows you to display the link as a disabled link, and the Visited property can alert the user that they already visited the specified link in the current instance of the LinkLabel.

You can display multiple links in a single LinkLabel control. Each LinkLabel.Link is added into the LinkLabel.LinkCollection associated with the LinkLabel control. To obtain the collection of links defined in a LinkLabel control, use the LinkLabel.Links property.

The following example demonstrates using the LinkLabel class, with multiple LinkArea sections defined, to display a label on a form. The example demonstrates setting the AutoSize, LinkBehavior, DisabledLinkColor, LinkColor, and VisitedLinkColor properties to customize the look of the LinkLabel. The first LinkArea is specified using the LinkLabel.LinkArea property. Additional links are added to the LinkLabel using the LinkLabel.LinkCollection.Add method. The example handles the LinkClicked event by starting the Web browser for hyperlinks, and displaying a MessageBox for other links.

using System;
using System.Drawing;
using System.Windows.Forms;

public class Form1 : System.Windows.Forms.Form
{
    private System.Windows.Forms.LinkLabel linkLabel1;

    [STAThread]
    static void Main() 
    {
        Application.Run(new Form1());
    }

    public Form1()
    {
        // Create the LinkLabel. 
        this.linkLabel1 = new System.Windows.Forms.LinkLabel();

        // Configure the LinkLabel's size and location. Specify that the 
        // size should be automatically determined by the content. 
        this.linkLabel1.Location = new System.Drawing.Point(34, 56);
        this.linkLabel1.Size = new System.Drawing.Size(224, 16);
        this.linkLabel1.AutoSize = true;

        // Configure the appearance.  
        // Set the DisabledLinkColor so that a disabled link will show up against the form's background. 
        this.linkLabel1.DisabledLinkColor = System.Drawing.Color.Red;
        this.linkLabel1.VisitedLinkColor = System.Drawing.Color.Blue;
        this.linkLabel1.LinkBehavior = System.Windows.Forms.LinkBehavior.HoverUnderline;
        this.linkLabel1.LinkColor = System.Drawing.Color.Navy;

        this.linkLabel1.TabIndex = 0;
        this.linkLabel1.TabStop = true;


        // Add an event handler to do something when the links are clicked. 
        this.linkLabel1.LinkClicked += new System.Windows.Forms.LinkLabelLinkClickedEventHandler(this.linkLabel1_LinkClicked);

        // Identify what the first Link is. 
        this.linkLabel1.LinkArea = new System.Windows.Forms.LinkArea(0, 8);

        // Identify that the first link is visited already. 
        this.linkLabel1.Links[0].Visited = true;

        // Set the Text property to a string. 
        this.linkLabel1.Text = "Register Online.  Visit Microsoft.  Visit MSN.";

        // Create new links using the Add method of the LinkCollection class. 
        // Underline the appropriate words in the LinkLabel's Text property. 
        // The words 'Register', 'Microsoft', and 'MSN' will  
        // all be underlined and behave as hyperlinks. 

        // First check that the Text property is long enough to accommodate 
        // the desired hyperlinked areas.  If it's not, don't add hyperlinks. 
        if(this.linkLabel1.Text.Length >= 45)
        {
            this.linkLabel1.Links[0].LinkData = "Register";
            this.linkLabel1.Links.Add(24, 9, "www.microsoft.com");
            this.linkLabel1.Links.Add(42, 3, "www.msn.com");
        //  The second link is disabled and will appear as red. 
            this.linkLabel1.Links[1].Enabled = false;
        }

        // Set up how the form should be displayed and add the controls to the form. 
        this.ClientSize = new System.Drawing.Size(292, 266);
        this.Controls.AddRange(new System.Windows.Forms.Control[] {this.linkLabel1});
        this.Text = "Link Label Example";
    }

    private void linkLabel1_LinkClicked(object sender, System.Windows.Forms.LinkLabelLinkClickedEventArgs e)
    {
        // Determine which link was clicked within the LinkLabel. 
        this.linkLabel1.Links[linkLabel1.Links.IndexOf(e.Link)].Visited = true;

        // Display the appropriate link based on the value of the  
        // LinkData property of the Link object. 
        string target = e.Link.LinkData as string;

        // If the value looks like a URL, navigate to it. 
        // Otherwise, display it in a message box. 
        if(null != target && target.StartsWith("www"))
        {
            System.Diagnostics.Process.Start(target);
        }
        else
        {    
            MessageBox.Show("Item clicked: " + target);
        }
    }
}

.NET Framework

Supported in: 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