Export (0) Print
Expand All

LinkLabel.ActiveLinkColor Property

Gets or sets the color used to display an active link.

[Visual Basic]
Public Property ActiveLinkColor As Color
[C#]
public Color ActiveLinkColor {get; set;}
[C++]
public: __property Color get_ActiveLinkColor();
public: __property void set_ActiveLinkColor(Color);
[JScript]
public function get ActiveLinkColor() : Color;
public function set ActiveLinkColor(Color);

Property Value

A Color that represents the color to display an active link. The default color is specified by the system, typically this color is Color.Red.

Remarks

An active link is a link that is in the process of being clicked. This is similar to the depressed state of a Button control. You can use this property to specify the color that the link is displayed in when the link is in the process of being clicked.

There are a number of colors associated with a link. The LinkColor specifies the color of all links displayed in the LinkLabel control. The VisitedLinkColor property enables you to specify the color of a link after it has been visited by the user. When a link is disabled, the DisabledLinkColor is used to display the link in a disabled state.

Note   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 in the process of being clicked.

Example

The following example demonstrates setting the LinkBehavior property using the LinkBehavior enumeration. It also demonstrates setting the ActiveLinkColor, Text and LinkVisited properties. To run this sample place it in a blank form and call InitializeLinkLabel from the form's constructor or Load method.

[SampleID='System.Windows.Forms.LinkLabelExample' SnippetID='1']
--------- Languages displayed= cs, vb ---------
--------- cs ---------
--------- Snippet 1 ---------
    // Declare the LinkLabel object.
    internal System.Windows.Forms.LinkLabel LinkLabel1;
    // Declare keywords array to identify links
    string[] keywords;
    private void InitializeLinkLabel()
    {
        this.LinkLabel1 = new System.Windows.Forms.LinkLabel();
        // Set the location, name and size.
        this.LinkLabel1.Location = new System.Drawing.Point(10, 20);
        this.LinkLabel1.Name = "CompanyLinks";
        this.LinkLabel1.Size = new System.Drawing.Size(104, 150);
        // Set the LinkBehavior property to show underline when mouse
        // hovers over the links.
        this.LinkLabel1.LinkBehavior = System.Windows.Forms.LinkBehavior.HoverUnderline;
        string textString = "For more information see our" +
            " company website or the research page at Contoso Ltd. ";
        // Set the text property.
        this.LinkLabel1.Text = textString;
        // Set the color of the links to black, unless the mouse
        // is hovering over a link.
        this.LinkLabel1.LinkColor = System.Drawing.Color.Black;
        this.LinkLabel1.ActiveLinkColor = System.Drawing.Color.Blue;
        // Associate the event-handling method with the LinkClicked
        // event.
        this.LinkLabel1.LinkClicked += 
            new LinkLabelLinkClickedEventHandler(LinkLabel1_LinkClicked);
        // Add links to the LinkCollection using starting index and
        // length of keywords.
        keywords = new string[]{"company", "research"};
        foreach ( string keyword in keywords )
        {
            this.LinkLabel1.Links.Add(textString.IndexOf(keyword), keyword.Length);
        }
        // Add the label to the form.
        this.Controls.Add(this.LinkLabel1);
    }
    private void LinkLabel1_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e)
    {
        string url = "";
        // Determine which link was clicked and set the appropriate url.
        switch(LinkLabel1.Links.IndexOf(e.Link))
        {
            case 0:
                url = "www.microsoft.com";
                break;
            case 1:
                url = "www.contoso.com/research";
                break;
        }
        // Set the visited property to True. This will change
        // the color of the link.
        e.Link.Visited = true;
        // Open Internet Explorer to the correct url.
        System.Diagnostics.Process.Start("IExplore.exe", url);
    }
--------- vb ---------
--------- Snippet 1 ---------
    ' Declare the LinkLabel object.
    Friend WithEvents LinkLabel1 As System.Windows.Forms.LinkLabel
    ' Declare keywords array to identify links
    Dim keywords() As String
    Private Sub InitializeLinkLabel()
        Me.LinkLabel1 = New System.Windows.Forms.LinkLabel
        ' Set the location, name and size.
        Me.LinkLabel1.Location = New System.Drawing.Point(10, 20)
        Me.LinkLabel1.Name = "CompanyLinks"
        Me.LinkLabel1.Size = New System.Drawing.Size(104, 150)
        ' Set the LinkBehavior property to show underline when mouse
        ' hovers over the links.
        Me.LinkLabel1.LinkBehavior = _
            System.Windows.Forms.LinkBehavior.HoverUnderline
        Dim textString As String = "For more information see our" & _
           " company website or the research page at Contoso Ltd. "
        ' Set the text property.
        Me.LinkLabel1.Text = textString
        ' Set the color of the links to black, unless the mouse
        ' is hovering over a link.
        Me.LinkLabel1.LinkColor = System.Drawing.Color.Black
        Me.LinkLabel1.ActiveLinkColor = System.Drawing.Color.Blue
        ' Add links to the LinkCollection using starting index and
        ' length of keywords.
        keywords = New String() {"company", "research"}
        Dim keyword As String
        For Each keyword In keywords
            Me.LinkLabel1.Links.Add(textString.IndexOf(keyword), keyword.Length)
        Next
        ' Add the label to the form.
        Me.Controls.Add(Me.LinkLabel1)
    End Sub
    Private Sub LinkLabel1_LinkClicked(ByVal sender As Object, 
        ByVal e As LinkLabelLinkClickedEventArgs) 
        Handles LinkLabel1.LinkClicked
        Dim url As String
        ' Determine which link was clicked and set the appropriate url.
        Select Case LinkLabel1.Links.IndexOf(e.Link)
            Case 0
                url = "www.microsoft.com"
            Case 1
                url = "www.contoso.com/research"
        End Select
        ' Set the visited property to True. This will change
        ' the color of the link.
        e.Link.Visited = True
        ' Open Internet Explorer to the correct url.
        System.Diagnostics.Process.Start("IExplore.exe", url)
   End Sub

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

LinkLabel Class | LinkLabel Members | System.Windows.Forms Namespace | Color | DisabledLinkColor | LinkColor | VisitedLinkColor

Show:
© 2014 Microsoft