Export (0) Print
Expand All

LinkLabel.DisabledLinkColor Property

Gets or sets the color used when displaying a disabled link.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

public Color DisabledLinkColor { get; set; }
/** @property */
public Color get_DisabledLinkColor ()

/** @property */
public void set_DisabledLinkColor (Color value)

public function get DisabledLinkColor () : Color

public function set DisabledLinkColor (value : Color)

Property Value

A Color that represents the color when displaying a disabled link. The default is Empty.

This property enables you to specify the color for links that are disabled in the LinkLabel. Disabled links do not cause the LinkClicked event to be raised.

There are a number of colors associated with a link. All links in the LinkLabel are initially displayed with the color defined in the LinkColor property. The ActiveLinkColor property enables you to specify the color of the link when it is in the process of being clicked. The VisitedLinkColor property enables you to specify the color of a link after it has been visited by the user.

NoteNote

When setting this property, ensure that the color you are setting the property to does not conflict with the color of the control's background or the text does not display properly. For example, if the background color of the control is Color.Red and this property is set to Color.Red, the text is not shown properly when the link is disabled.

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);
        }
    }
}

import System.*;
import System.Drawing.*;
import System.Windows.Forms.*;

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

    /** @attribute STAThread()
     */
    public static void main(String[] args)
    {
        Application.Run(new Form1());
    } //main

    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.set_Location(new System.Drawing.Point(34, 56));
        this.linkLabel1.set_Size(new System.Drawing.Size(224, 16));
        this.linkLabel1.set_AutoSize(true);
        // Configure the appearance. 
        // Set the DisabledLinkColor so that a disabled link will show up 
        // against the form's background.
        this.linkLabel1.set_DisabledLinkColor(System.Drawing.Color.get_Red());
        this.linkLabel1.set_VisitedLinkColor(System.Drawing.Color.get_Blue());
        this.linkLabel1.set_LinkBehavior(
            System.Windows.Forms.LinkBehavior.HoverUnderline);
        this.linkLabel1.set_LinkColor(System.Drawing.Color.get_Navy());

        this.linkLabel1.set_TabIndex(0);
        this.linkLabel1.set_TabStop(true);
        // Add an event handler to do something when the links are clicked.
        this.linkLabel1.add_LinkClicked(new System.Windows.Forms.
            LinkLabelLinkClickedEventHandler(this.linkLabel1_LinkClicked));
        // Identify what the first Link is.
        this.linkLabel1.set_LinkArea(new System.Windows.Forms.LinkArea(0, 8));
        // Identify that the first link is visited already.
        this.linkLabel1.get_Links().get_Item(0).set_Visited(true);
        // Set the Text property to a string.
        this.linkLabel1.set_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.get_Text().get_Length() >= 45) {
            this.linkLabel1.get_Links().get_Item(0).set_LinkData("Register");
            this.linkLabel1.get_Links().Add(24, 9, "www.microsoft.com");
            this.linkLabel1.get_Links().Add(42, 3, "www.msn.com");
            //  The second link is disabled and will appear as red.
            this.linkLabel1.get_Links().get_Item(1).set_Enabled(false);
        }
        // Set up how the form should be displayed and add the controls to 
        // the form.
        this.set_ClientSize(new System.Drawing.Size(292, 266));
        this.get_Controls().AddRange(new System.Windows.Forms.Control[] { 
            this.linkLabel1 });
        this.set_Text("Link Label Example");
    } //Form1

    private void linkLabel1_LinkClicked(Object sender, 
        System.Windows.Forms.LinkLabelLinkClickedEventArgs e)
    {
        // Determine which link was clicked within the LinkLabel.
        this.linkLabel1.get_Links().get_Item(linkLabel1.get_Links().
            IndexOf(e.get_Link())).set_Visited(true);
        // Display the appropriate link based on the value of the 
        // LinkData property of the Link object.
        String target = (String)e.get_Link().get_LinkData();
        // 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);
        }
    } //linkLabel1_LinkClicked
} //Form1

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft