UIElement.IsMouseCaptured Property

.NET Framework (current version)

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)

Syntax

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

Remarks

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

Dependency Property Information

Identifier field	IsMouseCapturedProperty
Metadata properties set to true	None

Examples

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

Version Information

.NET Framework
Available since 3.0