Export (0) Print
Expand All

UIElement.IsMouseCaptured Property

Gets a value indicating whether the mouse is captured to this element. This is a dependency property.

Namespace:  System.Windows
Assembly:  PresentationCore (in PresentationCore.dll)

public bool IsMouseCaptured { get; }

Property Value

Type: System.Boolean
true if the element has mouse capture; otherwise, false. The default is false.

Implements

IInputElement.IsMouseCaptured

Identifier field

IsMouseCapturedProperty

Metadata properties set to true

None

Mouse capture state is related to in-process drag-and-drop operations.

The following example turns the mouse capture state on or off based on whether the mouse is already captured for the element.

If mouse capture is elsewhere, the mouse capture is set to that element. If the element had mouse capture, it is cleared by calling Mouse.Capture with a null input.

private void CaptureMouseCommandExecuted(object sender, ExecutedRoutedEventArgs e)
{
    MessageBox.Show("Mouse Command");
    IInputElement target = Mouse.DirectlyOver;

    target = target as Control;
    if (target != null)
    {
        if (!target.IsMouseCaptured)
        {
            Mouse.Capture(target);
        }
        else
        {
            Mouse.Capture(null);
        }
    }
}

.NET Framework

Supported in: 4.5.3, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

Show:
© 2014 Microsoft