MouseDevice.Capture Method (IInputElement, CaptureMode)

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

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

public bool Capture(
	IInputElement element,
	CaptureMode captureMode
)

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.

ExceptionCondition
InvalidOperationException

element is not a UIElement or ContentElement.

InvalidEnumArgumentException

captureMode is not a valid CaptureMode.

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

To release mouse capture, call Capture passing null 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.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.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