Export (0) Print
Expand All
Expand Minimize

Control.Capture Property

Gets or sets a value indicating whether the control has captured the mouse.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

public bool Capture { get; set; }
/** @property */
public boolean get_Capture ()

/** @property */
public void set_Capture (boolean value)

public function get Capture () : boolean

public function set Capture (value : boolean)

Property Value

true if the control has captured the mouse; otherwise, false.

When a control has captured the mouse, it receives mouse input whether or not the cursor is within its borders. The mouse is typically only captured during drag operations.

Only the foreground window can capture the mouse. When a background window attempts to do so, the window receives messages only for mouse events that occur when the mouse cursor is within the visible portion of the window. Also, even if the foreground window has captured the mouse, the user can still click another window, bringing it to the foreground.

When the mouse is captured, shortcut keys should not work.

The following code example demonstrates the Capture property. To run this example paste the following code in a form containing a Label named label1 and two Listbox controls named listbox1 and listbox2. Ensure the form and controls' MouseDown event is associated with the method in this example.

// This method handles the mouse down event for all the controls on the form.  
// When a control has captured the mouse
// the control's name will be output on label1.
private void Control_MouseDown(System.Object sender, 
    System.Windows.Forms.MouseEventArgs e)
{
    Control control = (Control) sender;
    if (control.Capture)
    {
        label1.Text = control.Name+" has captured the mouse";
    }
}

// This method handles the mouse down event for all the controls on 
//the form. When a control has captured the mouse the control's name 
// will be output on label1.
private void Control_MouseDown(Object sender, 
    System.Windows.Forms.MouseEventArgs e)
{
    Control control = (Control)sender;
    if (control.get_Capture()) {
        label1.set_Text(control.get_Name() + " has captured the mouse");
    }
} //Control_MouseDown

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft