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)

[SecurityCriticalAttribute]
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.

Exception Condition
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
Available since 3.0
Return to top
Show: