Attempts to force capture of the mouse to this element.
Assembly: PresentationCore (in PresentationCore.dll)
To be captured, an element must be enabled. Check whether IsEnabled is true before you call .
If calling returns true, then IsMouseCaptured is also true.
If calling returns true, then the GotMouseCapture and IsMouseCapturedChanged events are raised, with RoutedEventArgs.Source in the event data reported as the element where the 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 a null reference (Nothing in Visual Basic).
The following example captures the mouse or releases capture, based on whether the mouse is already captured by the element. Note that this example casts the prospective capture target element to the IInputElement interface, and is thus initially calling the IInputElement.CaptureMouse method. Casting to IInputElement is a technique that is useful if you are unsure whether the element you want to have capture the mouse is a UIElement or a ContentElement. The interface cast and the interface method call then calls the appropriate type-specific CaptureMouse implementation internally without requiring a trial cast to either UIElement or ContentElement. This same casting technique works for other members that IInputElement defines, for instance many of the input-related events, and other input-related methods.
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.