Attempts to force capture of the mouse to this element.
(in PresentationCore.dll)
Visual Basic (Declaration)
Public Function CaptureMouse As Boolean
Dim instance As UIElement
Dim returnValue As Boolean
returnValue = instance.CaptureMouse()
public bool CaptureMouse()
public:
virtual bool CaptureMouse() sealed
public final function CaptureMouse() : boolean
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 nullNothingnullptra null reference (Nothing in Visual Basic).
The following example implements a pair of handlers for mouse and key input combination that capture (and uncapture) the mouse and enable a special mouse mode for viewing a 3D model.
private void MouseDownHandler(object sender, MouseButtonEventArgs e)
{
if (!Enabled) return;
e.Handled = true;
if (Keyboard.IsKeyDown(Key.F1) == true)
{
Reset();
return;
}
UIElement el = (UIElement)sender;
_point = e.MouseDevice.GetPosition(el);
// Initialize the center of rotation to the lookatpoint
if (!_centered)
{
ProjectionCamera camera = (ProjectionCamera)_slaves[0].Camera;
_center = camera.LookDirection;
_centered = true;
}
_scaling = (e.MiddleButton == MouseButtonState.Pressed);
if (Keyboard.IsKeyDown(Key.Space) == false)
_rotating = true;
else
_rotating = false;
el.CaptureMouse();
}
private void MouseUpHandler(object sender, MouseButtonEventArgs e)
{
if (!_enabled) return;
e.Handled = true;
// Stuff the current initial + delta into initial so when we next move we
// start at the right place.
if (_rotating == true)
_rotation = _rotationDelta * _rotation;
else
{
_translate += _translateDelta;
_translateDelta.X = 0;
_translateDelta.Y = 0;
}
//_scale = _scaleDelta*_scale;
UIElement el = (UIElement)sender;
el.ReleaseMouseCapture();
}
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, 3.0
Reference
Other Resources