Export (0) Print
Expand All

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)

[BrowsableAttribute(false)]
public bool Capture { get; set; }

Property Value

Type: System.Boolean
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";
		}
	}

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft