Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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)
XML Namespace:  http://schemas.microsoft.com/winfx/2006/xaml/presentation

public bool IsMouseCaptured { get; }
/** @property */
public final boolean get_IsMouseCaptured ()

public final function get IsMouseCaptured () : boolean

You cannot use this property in XAML.

Property Value

true if the element has mouse capture; otherwise, false. The default is false.

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);
        }
    }
}

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0

Community Additions

Show:
© 2017 Microsoft