UIElement3D.CaptureMouse Method

Definition

Namespace:

System.Windows

Assembly:

PresentationCore.dll

Attempts to force capture of the mouse to this element.

C#

public bool CaptureMouse();

Returns

Boolean

true if the mouse is successfully captured; otherwise, false.

Implements

CaptureMouse()

Remarks

To be captured, an element must be enabled. Check whether IsEnabled is true before you call CaptureMouse.

If calling CaptureMouse returns true, then IsMouseCaptured is also true.

If calling CaptureMouse returns true, then the GotMouseCapture and IsMouseCapturedChanged events are raised, with RoutedEventArgs.Source in the event data reported as the element where the CaptureMouse method is called. If you force capture, you might interfere with existing captures - especially with captures that relate to drag-and-drop with the mouse.

To clear mouse capture from all elements, call Mouse.Capture with the element parameter provided as null.

Applies to

See also

• IsMouseCaptured