LinkClickedEventArgs.LinkText Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Gets the text of the link being clicked.

public:
 property System::String ^ LinkText { System::String ^ get(); };

public string? LinkText { get; }

member this.LinkText : string

Public ReadOnly Property LinkText As String

Property Value

String

The text of the link that is clicked in the RichTextBox control.

Examples

The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the RichTextBox.LinkClicked event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing MessageBox.Show with Console.WriteLine or appending the message to a multiline TextBox.

To run the example code, paste it into a project that contains an instance of type RichTextBox named RichTextBox1. Then ensure that the event handler is associated with the RichTextBox.LinkClicked event.

private void RichTextBox1_LinkClicked(Object sender, LinkClickedEventArgs e) {

System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "LinkText", e.LinkText );
messageBoxCS.AppendLine();
MessageBox.Show(messageBoxCS.ToString(), "LinkClicked Event" );
}

Private Sub RichTextBox1_LinkClicked(sender as Object, e as LinkClickedEventArgs) _ 
     Handles RichTextBox1.LinkClicked

    Dim messageBoxVB as New System.Text.StringBuilder()
    messageBoxVB.AppendFormat("{0} = {1}", "LinkText", e.LinkText)
    messageBoxVB.AppendLine()
    MessageBox.Show(messageBoxVB.ToString(),"LinkClicked Event")

End Sub

Remarks

The text returned by this property could be a file, URL, or other data specified by the link that is clicked.