Export (0) Print
Expand All
4 out of 7 rated this helpful - Rate this topic

Control.DoubleClick Event

Occurs when the control is double-clicked.

[Visual Basic]
Public Event DoubleClick As EventHandler
[C#]
public event EventHandler DoubleClick;
[C++]
public: __event EventHandler* DoubleClick;

[JScript] In JScript, you can handle the events defined by a class, but you cannot define your own.

Event Data

The event handler receives an argument of type EventArgs.

Remarks

A double-click is determined by the mouse settings of the user's operating system. The user can set the time between clicks of a mouse button that should be considered a double-click rather than two clicks. The Click event is raised every time a control is double-clicked. For example, if you have an event-handling methods for the Click and DoubleClick events of a Form, the Click and DoubleClick events are raised when the form is double-clicked and both methods are called. If a control is double-clicked and that control does not support the DoubleClick event, the Click event might be raised twice.

The ControlStyles.StandardDoubleClick and ControlStyles.StandardClick bits must be set to true for this event to be raised. These bits might already be set to true if you are inheriting from existing Windows Forms controls.

Notes to Inheritors:  Inheriting from a standard Windows Forms control and changing the StandardClick or StandardDoubleClick bit values to true can cause unexpected behavior or have no effect at all if the control does not support the Click or DoubleClick events.

The following table lists Windows Forms controls and which event (Click or DoubleClick) is raised in response to the mouse action specified.

Control Left Mouse Click Left Mouse Double Click Right Mouse Click Right Mouse Double Click Middle Mouse Click Middle Mouse Double Click XButton1 Mouse Click XButton1 Mouse Double-Click XButton2 Mouse Click XButton2 Mouse Double-Click
MonthCalendar,

DateTimePicker,

RichTextBox,

HScrollBar,

VScrollBar

none none none none none none none none none none
Button,

CheckBox,

RadioButton

Click Click, Click none none none none none none none none
ListBox,

CheckedListBox,

ComboBox

Click Click, DoubleClick none none none none none none none none
TextBox,

DomainUpDown,

NumericUpDown

Click Click, DoubleClick none none none none none none none none
* TreeView,

* ListView

Click Click, DoubleClick Click Click, DoubleClick none none none none none none
ProgressBar,

TrackBar

Click Click, Click Click Click, Click Click Click, Click Click Click, Click Click Click, Click
Form,

DataGrid,

Label,

LinkLabel,

Panel,

GroupBox,

PictureBox,

Splitter,

StatusBar,

ToolBar,

TabPage,

** TabControl

Click Click, DoubleClick Click Click, DoubleClick Click Click, DoubleClick Click Click, DoubleClick Click Click, DoubleClick

* The mouse pointer must be over a child object (TreeNode or ListViewItem).

** The TabControl must have at least one TabPage in its TabPages collection.

Note   The following events are not raised for the TabControl class unless there is at least one TabPage in the TabControl.TabPages collection: Click, DoubleClick, MouseDown, MouseUp, MouseHover, MouseEnter, MouseLeave and MouseMove. If there is at least one TabPage in the collection, and the user interacts with the tab controls header (where the TabPage names appear), the TabControl raises the appropriate event. However, if the user interaction is within the client area of the tab page, the TabPage raises the appropriate event.

For more information about handling events, see Consuming Events.

Example

[Visual Basic] 
' This example uses the DoubleClick event of a ListBox to load text files  
' listed in the ListBox into a TextBox control. This example
' assumes that the ListBox, named listBox1, contains a list of valid file 
' names with path and that this event handling method
' is connected to the DoublClick event of a ListBox control named listBox1.
' This example requires code access permission to access files.
Private Sub listBox1_DoubleClick(ByVal sender As Object, ByVal e As System.EventArgs) Handles listBox1.DoubleClick
    ' Get the name of the file to open from the ListBox.
    Dim file As [String] = listBox1.SelectedItem.ToString()

    Try
        ' Determine if the file exists before loading.
        If System.IO.File.Exists(file) Then
            ' Open the file and use a TextReader to read the contents into the TextBox.
            Dim myFile As New System.IO.FileInfo(listBox1.SelectedItem.ToString())
            Dim myData As System.IO.TextReader = myFile.OpenText()

            textBox1.Text = myData.ReadToEnd()
            myData.Close()
        End If
        ' Exception is thrown by the OpenText method of the FileInfo class.
    Catch
        MessageBox.Show("The file you specified does not exist.")
        ' Exception is thrown by the ReadToEnd method of the TextReader class.
    Catch
     MessageBox.Show("There was a problem loading the file into the TextBox. Ensure that the file is a valid text file.")
    End Try
End Sub

[C#] 
// This example uses the DoubleClick event of a ListBox to load text files
// listed in the ListBox into a TextBox control. This example
// assumes that the ListBox, named listBox1, contains a list of valid file
// names with path and that this event handling method
// is connected to the DoublClick event of a ListBox control named listBox1.
// This example requires code access permission to access files.
private void listBox1_DoubleClick(object sender, System.EventArgs e)
{
    // Get the name of the file to open from the ListBox.
    String file = listBox1.SelectedItem.ToString();

    try
    {
        // Determine if the file exists before loading.
        if (System.IO.File.Exists(file))
        {
            // Open the file and use a TextReader to read the contents into the TextBox.
            System.IO.FileInfo myFile = new System.IO.FileInfo(listBox1.SelectedItem.ToString());
            System.IO.TextReader myData = myFile.OpenText();;

            textBox1.Text = myData.ReadToEnd();
            myData.Close();
        }
    }
        // Exception is thrown by the OpenText method of the FileInfo class.
    catch(System.IO.FileNotFoundException)
    {
        MessageBox.Show("The file you specified does not exist.");
    }
        // Exception is thrown by the ReadToEnd method of the TextReader class.
    catch(System.IO.IOException)
    {
        MessageBox.Show("There was a problem loading the file into the TextBox. Ensure that the file is a valid text file.");
    }
}

[C++] 
// This example uses the DoubleClick event of a ListBox to load text files
// listed in the ListBox into a TextBox control. This example
// assumes that the ListBox, named listBox1, contains a list of valid file
// names with path and that this event handling method
// is connected to the DoublClick event of a ListBox control named listBox1.
// This example requires code access permission to access files.
private:
void listBox1_DoubleClick(Object* /*sender*/, System::EventArgs* /*e*/)
{
   // Get the name of the file to open from the ListBox.
   String* file = listBox1->SelectedItem->ToString();
   try
   {
      // Determine if the file exists before loading.
      if (System::IO::File::Exists(file))
      {
         // Open the file and use a TextReader to read the contents into the TextBox.
         System::IO::FileInfo* myFile = new System::IO::FileInfo(listBox1->SelectedItem->ToString());
         System::IO::TextReader* myData = myFile->OpenText();;

         textBox1->Text = myData->ReadToEnd();
         myData->Close();
      }
   }
   // Exception is thrown by the OpenText method of the FileInfo class.
   catch(System::IO::FileNotFoundException*)
   {
      MessageBox::Show(S"The file you specified does not exist.");
   }
   // Exception is thrown by the ReadToEnd method of the TextReader class.
   catch(System::IO::IOException*)
   {
      MessageBox::Show(S"There was a problem loading the file into the TextBox. Ensure that the file is a valid text file.");
   }
}

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

Control Class | Control Members | System.Windows.Forms Namespace | OnDoubleClick | StandardClick | StandardDoubleClick

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.