Export (0) Print
Expand All

LinkLabel::LinkClicked Event

Occurs when a link is clicked within the control.

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

public:
 event LinkLabelLinkClickedEventHandler^ LinkClicked {
	void add (LinkLabelLinkClickedEventHandler^ value);
	void remove (LinkLabelLinkClickedEventHandler^ value);
}

Typically, the LinkClicked event is handled to perform tasks when the user clicks on a link in the control. The event handler for the LinkClicked event is passed an instance of the LinkLabelLinkClickedEventArgs class that contains a LinkLabel::Link object that is associated with the link that was clicked. You can use information specified in the LinkData property of LinkLabel::Link class to determine which link was clicked or what type of task to perform when the link is clicked. For example, if a LinkLabel control has a LinkLabel::Link object defined with its LinkData property set to the string www.microsoft.com, you can use this information in an event handler for the LinkClicked event to display the Web site.

For more information about handling events, see Handling and Raising Events.

The following example demonstrates using the LinkLabel class. The example handles the LinkClicked event by opening a Web site.

No code example is currently available or this language may not be supported.

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.dll>
#using <System.Windows.Forms.dll>
#using <System.Drawing.dll>

using namespace System;
using namespace System::Drawing;
using namespace System::Windows::Forms;
public ref class Form1: public System::Windows::Forms::Form
{
private:
   System::Windows::Forms::LinkLabel^ linkLabel1;

public:
   Form1()
   {

      // Create the LinkLabel. 
      this->linkLabel1 = gcnew 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 = System::Drawing::Point( 34, 56 );
      this->linkLabel1->Size = System::Drawing::Size( 224, 16 );
      this->linkLabel1->AutoSize = true;

      // Configure the appearance. 
      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 += gcnew System::Windows::Forms::LinkLabelLinkClickedEventHandler( this, &Form1::linkLabel1_LinkClicked );

      // Identify what the first Link is. 
      this->linkLabel1->LinkArea = 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" );
         this->linkLabel1->Links[ 1 ]->Enabled = false;
      }


      // Set up how the form should be displayed and add the controls to the form. 
      this->ClientSize = System::Drawing::Size( 292, 266 );
      array<System::Windows::Forms::Control^>^temp0 = {this->linkLabel1};
      this->Controls->AddRange( temp0 );
      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 = dynamic_cast<String^>(e->Link->LinkData);

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

[STAThread]
int main()
{
   Application::Run( gcnew Form1 );
}

.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.

Show:
© 2014 Microsoft