LinkLabel.LinkCollection.Add LinkLabel.LinkCollection.Add LinkLabel.LinkCollection.Add LinkLabel.LinkCollection.Add Method

Definition

Adds a link to the collection.

Overloads

Add(LinkLabel+Link) Add(LinkLabel+Link) Add(LinkLabel+Link) Add(LinkLabel+Link)

Adds a link with the specified value to the collection.

Add(Int32, Int32) Add(Int32, Int32) Add(Int32, Int32) Add(Int32, Int32)

Adds a link to the collection.

Add(Int32, Int32, Object) Add(Int32, Int32, Object) Add(Int32, Int32, Object) Add(Int32, Int32, Object)

Adds a link to the collection with information to associate with the link.

Adds a link with the specified value to the collection.

public:
 int Add(System::Windows::Forms::LinkLabel::Link ^ value);
public int Add (System.Windows.Forms.LinkLabel.Link value);
member this.Add : System.Windows.Forms.LinkLabel.Link -> int
Public Function Add (value As LinkLabel.Link) As Integer

Parameters

Returns

The zero-based index where the link specified by the value parameter is located in the collection.

Add(Int32, Int32) Add(Int32, Int32) Add(Int32, Int32) Add(Int32, Int32)

Adds a link to the collection.

public:
 System::Windows::Forms::LinkLabel::Link ^ Add(int start, int length);
public System.Windows.Forms.LinkLabel.Link Add (int start, int length);
member this.Add : int * int -> System.Windows.Forms.LinkLabel.Link
Public Function Add (start As Integer, length As Integer) As LinkLabel.Link

Parameters

start
Int32 Int32 Int32 Int32

The starting character within the text of the label where the link is created.

length
Int32 Int32 Int32 Int32

The number of characters after the starting character to include in the link text.

Returns

A LinkLabel.Link representing the link that was created and added to the collection.

Examples

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

   // Declare the LinkLabel object.
internal:
   System::Windows::Forms::LinkLabel^ LinkLabel1;

   // Declare keywords array to identify links
   array<String^>^keywords;

private:
   void InitializeLinkLabel()
   {
      this->LinkLabel1 = gcnew System::Windows::Forms::LinkLabel;
      this->LinkLabel1->Links->Clear();
      // Set the location, name and size.
      this->LinkLabel1->Location = System::Drawing::Point( 10, 20 );
      this->LinkLabel1->Name = "CompanyLinks";
      this->LinkLabel1->Size = 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 += gcnew LinkLabelLinkClickedEventHandler( this, &Form1::LinkLabel1_LinkClicked );
      
      // Add links to the LinkCollection using starting index and
      // length of keywords.
      array<String^>^temp0 = {"company","research"};
      keywords = temp0;
      System::Collections::IEnumerator^ myEnum = keywords->GetEnumerator();
      while ( myEnum->MoveNext() )
      {
         String^ keyword = safe_cast<String^>(myEnum->Current);
         this->LinkLabel1->Links->Add( textString->IndexOf( keyword ), keyword->Length );
      }

      
      // Add the label to the form.
      this->Controls->Add( this->LinkLabel1 );
   }

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

// 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();
               this.LinkLabel1.Links.Clear();

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

' 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
    Me.LinkLabel1.Links.Clear()
    ' 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

Remarks

A LinkLabel control can display multiple links within the text of the control. The Add method enables you to convert text within the LinkLabel control to a link that can be clicked on by the user to perform tasks similar to a Button control. This method adds the link that is created to the LinkLabel.LinkCollection for the LinkLabel. For example, if you want to set the word "quick" in the label text, "The quick brown fox", you call this method with the start parameter set to the value of four (4), and the length parameter to five (5). The word "quick" then changes to a link and the link is added to the collection. If you want to associate information with the link, such as the URL to display or a file to open when the user clicks on the link, use the other version of the Add method.

Note

Two links cannot share the same text. If you create a link that uses text that is already used by another link, an exception is thrown.

Add(Int32, Int32, Object) Add(Int32, Int32, Object) Add(Int32, Int32, Object) Add(Int32, Int32, Object)

Adds a link to the collection with information to associate with the link.

public:
 System::Windows::Forms::LinkLabel::Link ^ Add(int start, int length, System::Object ^ linkData);
public System.Windows.Forms.LinkLabel.Link Add (int start, int length, object linkData);
member this.Add : int * int * obj -> System.Windows.Forms.LinkLabel.Link
Public Function Add (start As Integer, length As Integer, linkData As Object) As LinkLabel.Link

Parameters

start
Int32 Int32 Int32 Int32

The starting character within the text of the label where the link is created.

length
Int32 Int32 Int32 Int32

The number of characters after the starting character to include in the link text.

linkData
Object Object Object Object

The object containing the information to associate with the link.

Returns

A LinkLabel.Link representing the link that was created and added to the collection.

Examples

The following code example creates a LinkLabel control that displays a link, and displays the Microsoft Web site in the default browser when the link defined in the control's text is clicked. The example defines a method that initializes the LinkLabel control as well as a method that will handle the LinkClicked event of the control. The event handler of the LinkClicked event uses the LinkData property of the LinkLabel.Link class to determine the URL to display in the default browser. This example requires that it is located within a Form class.

   // Create a new LinkLabel control.
private:
   LinkLabel^ linkLabel1;

public:
   void InitializeMyLinkLabel()
   {
      // Set the control to autosize based on the text content.
      linkLabel1->AutoSize = true;

      // Position and size the control on the form.
      linkLabel1->Location = System::Drawing::Point( 8, 16 );
      linkLabel1->Size = System::Drawing::Size( 135, 13 );

      // Set the text to display in the label.
      linkLabel1->Text = "Click here to get more info.";

      // Create a new link using the Add method of the LinkCollection class.
      linkLabel1->Links->Add( 6, 4, "www.microsoft.com" );

      // Create an event handler for the LinkClicked event.
      linkLabel1->LinkClicked += gcnew System::Windows::Forms::LinkLabelLinkClickedEventHandler( this, &Form1::linkLabel1_LinkClicked );

      // Add the control to the form.
      this->Controls->Add( linkLabel1 );
   }

private:
   void linkLabel1_LinkClicked( Object^ /*sender*/, System::Windows::Forms::LinkLabelLinkClickedEventArgs^ e )
   {
      // Determine which link was clicked within the LinkLabel.
      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.
      System::Diagnostics::Process::Start( e->Link->LinkData->ToString() );
   }
    // Create a new LinkLabel control.
private LinkLabel linkLabel1 = new LinkLabel();

public void InitializeMyLinkLabel()
{
	
	// Set the control to autosize based on the text content.
	linkLabel1.AutoSize = true;
	// Position and size the control on the form.
	linkLabel1.Location = new System.Drawing.Point(8,16);
	linkLabel1.Size = new System.Drawing.Size(135,13);
	// Set the text to display in the label.
	linkLabel1.Text = "Click here to get more info.";

	// Create a new link using the Add method of the LinkCollection class.
	linkLabel1.Links.Add(6,4,"www.microsoft.com");

	// Create an event handler for the LinkClicked event.
	linkLabel1.LinkClicked += new System.Windows.Forms.LinkLabelLinkClickedEventHandler(this.linkLabel1_LinkClicked);

	// Add the control to the form.
	this.Controls.Add(linkLabel1);
}

private void linkLabel1_LinkClicked(object sender, System.Windows.Forms.LinkLabelLinkClickedEventArgs e)
{
	// Determine which link was clicked within the LinkLabel.
	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.
	System.Diagnostics.Process.Start(e.Link.LinkData.ToString());
}
' Create a new LinkLabel control.
Private linkLabel1 As New LinkLabel()


Public Sub InitializeMyLinkLabel()
    
    ' Set the control to autosize based on the text content.
    linkLabel1.AutoSize = True
    ' Position and size the control on the form.
    linkLabel1.Location = New System.Drawing.Point(8, 16)
    linkLabel1.Size = New System.Drawing.Size(135, 13)
    ' Set the text to display in the label.
    linkLabel1.Text = "Click here to get more info."
    
    ' Create a new link using the Add method of the LinkCollection class.
    linkLabel1.Links.Add(6, 4, "www.microsoft.com")
    
    ' Create an event handler for the LinkClicked event.
    AddHandler linkLabel1.LinkClicked, AddressOf Me.linkLabel1_LinkClicked
    
    ' Add the control to the form.
    Me.Controls.Add(linkLabel1)
End Sub 'InitializeMyLinkLabel


Private Sub linkLabel1_LinkClicked(sender As Object, e As System.Windows.Forms.LinkLabelLinkClickedEventArgs)
    ' Determine which link was clicked within the LinkLabel.
    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.
    System.Diagnostics.Process.Start(e.Link.LinkData.ToString())
End Sub 'linkLabel1_LinkClicked

Remarks

A LinkLabel control can display multiple links within the text of the control. The Add method enables you to convert text within the LinkLabel control to a link that can be clicked on by the user to perform tasks similar to a Button control. This method adds the link that is created to the LinkLabel.LinkCollection for the LinkLabel. For example, if you want to set the word "quick" in the label text, "The quick brown fox", you call this method with the start parameter set to the value of four (4), and the length parameter to five (5). The word "quick" then changes to a link and the link is added to the collection. This version of the Add method enables you to provide additional information that can be associated with the link through the linkData parameter. For example, you can pass a String to the linkData parameter that contains a URL to display when the link is clicked. You can then use this information in your handler for the LinkClicked event of the LinkLabel control to display the URL in Microsoft Internet Explorer.

Note

Two links cannot share the same text. If you create a link that uses text that is already used by another link, an exception is thrown.

Applies to