Expand Minimize
This topic has not yet been rated - Rate this topic

UIElement3D.CaptureMouse Method

Attempts to force capture of the mouse to this element.

Namespace:  System.Windows
Assembly:  PresentationCore (in PresentationCore.dll)
public bool CaptureMouse()
You cannot use methods in XAML.

Return Value

Type: System.Boolean
true if the mouse is successfully captured; otherwise, false.

Implements

IInputElement.CaptureMouse()

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.

CaptureMouse is introduced in the .NET Framework version 3.5. For more information, see .NET Framework 3.5 Architecture.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5 SP1, 3.0 SP1
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.