LinkArea Structure


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Represents an area within a LinkLabel control that represents a hyperlink within the control.

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

public value struct LinkArea

System_CAPS_pubmethodLinkArea(Int32, Int32)

Initializes a new instance of the LinkArea class.


Gets a value indicating whether the LinkArea is empty.


Gets or sets the number of characters in the link area.


Gets or sets the starting location of the link area within the text of the LinkLabel.


Determines whether this LinkArea is equal to the specified object.(Overrides ValueType::Equals(Object^).)


Returns the hash code for this instance.(Overrides ValueType::GetHashCode().)


Gets the Type of the current instance.(Inherited from Object.)


Returns the fully qualified type name of this instance.(Overrides ValueType::ToString().)

System_CAPS_puboperatorSystem_CAPS_staticEquality(LinkArea, LinkArea)

Returns a value indicating whether two instances of the LinkArea class are equal.

System_CAPS_puboperatorSystem_CAPS_staticInequality(LinkArea, LinkArea)

Returns a value indicating whether two instances of the LinkArea class are not equal.

There are two ways to add a hyperlink to the text of a LinkLabel control. You can access the Add method of the LinkLabel::LinkCollection class through the Links property of the LinkLabel to add multiple hyperlinks to the control's text. If you only need to add a single hyperlink to the text of the control, you can use the LinkArea property of the LinkLabel. This property accepts a LinkArea that defines the location of the hyperlink within the control's text. When a hyperlink is specified using the LinkArea property, the link area is then added to the LinkLabel::LinkCollection in the same manner as adding the link using the Add method of the LinkLabel::LinkCollection.

The Length property specifies the number of characters within the text of the LinkLabel to include in the link area. The Start property specifies the first character in the control text to include in the hyperlink. If you want to determine whether a specific LinkArea is empty, you can use the IsEmpty property instead of checking the values of the Start and Length properties.

The following code 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
   System::Windows::Forms::LinkLabel^ linkLabel1;


      // 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, "" );
         this->linkLabel1->Links->Add( 42, 3, "" );
         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";

   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 );
         MessageBox::Show( "Item clicked: {0}", target );

int main()
   Application::Run( gcnew Form1 );

.NET Framework
Available since 1.1

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

Return to top