Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Capture Method (IInputElement, CaptureMode)
Collapse the table of content
Expand the table of content

Mouse.Capture Method (IInputElement, CaptureMode)

Captures mouse input to the specified element using the specified CaptureMode.

Namespace:  System.Windows.Input
Assembly:  PresentationCore (in PresentationCore.dll)

'Declaration
Public Shared Function Capture ( _
	element As IInputElement, _
	captureMode As CaptureMode _
) As Boolean

Parameters

element
Type: System.Windows.IInputElement

The element to capture the mouse.

captureMode
Type: System.Windows.Input.CaptureMode

The capture policy to use.

Return Value

Type: System.Boolean
true if the element was able to capture the mouse; otherwise, false.

When an element captures the mouse, it receives mouse input whether the cursor is within its borders.

To release mouse capture, call Capture passing Nothing as the element to capture.

If the mouse is captured when a MouseDown or MouseUp event is raised and the input is not going to the element underneath the mouse, PreviewMouseDownOutsideCapturedElement and PreviewMouseUpOutsideCapturedElement are raised first. This enables the captured element a chance to release capture before the MouseDown and MouseUp events are routed.

The following example shows how to capture the mouse to a specific element by using the Capture method.

		Private Sub OnCaptureMouseRequest(ByVal sender As Object, ByVal e As RoutedEventArgs)
			Mouse.Capture(_elementToCapture)
		End Sub

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft