Windows Dev Center

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)

'Declaration
Public ReadOnly Property IsMouseCaptured As Boolean

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 Sub CaptureMouseCommandExecuted(ByVal sender As Object, ByVal e As ExecutedRoutedEventArgs)
    MessageBox.Show("Mouse Command")
    Dim target As IInputElement = Mouse.DirectlyOver

    target = TryCast(target, Control)
    If target IsNot Nothing Then
        If Not target.IsMouseCaptured Then
            Mouse.Capture(target)
        Else
            Mouse.Capture(Nothing)
        End If
    End If
End Sub

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft