IsMouseCaptured Property

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.

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

Identifier field

IsMouseCapturedProperty

Metadata properties set to true

None

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
Available since 3.0
Return to top
Show:
© 2016 Microsoft