UIElement3D.CaptureMouse Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Attempts to force capture of the mouse to this element.
public:
virtual bool CaptureMouse();public bool CaptureMouse ();abstract member CaptureMouse : unit -> bool
override this.CaptureMouse : unit -> boolPublic Function CaptureMouse () As BooleanReturns
true if the mouse is successfully captured; otherwise, false.
Implements
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.
