LinkLabelLinkClickedEventArgs.Button Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

LinkLabelLinkClickedEventArgs.cs

Gets the mouse button that causes the link to be clicked.

public:
 property System::Windows::Forms::MouseButtons Button { System::Windows::Forms::MouseButtons get(); };

public System.Windows.Forms.MouseButtons Button { get; }

member this.Button : System.Windows.Forms.MouseButtons

Public ReadOnly Property Button As MouseButtons

Property Value

MouseButtons

One of the MouseButtons values.

Examples

The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the LinkLabel.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 LinkLabel named LinkLabel1. Then ensure that the event handler is associated with the LinkLabel.LinkClicked event.

private void LinkLabel1_LinkClicked(Object sender, LinkLabelLinkClickedEventArgs e) {

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

Private Sub LinkLabel1_LinkClicked(sender as Object, e as LinkLabelLinkClickedEventArgs) _ 
     Handles LinkLabel1.LinkClicked

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

End Sub