取消

CaptureMouse/CaptureStylus 可能会失败

在 WPF 中,如果我们要做拖动效果,通常会调用一下 CaptureMouse/CaptureStylus 以便当鼠标或手指离开控件的时候依然能够响应 MoveUp 事件。不知有没有注意到这两个函数其实是有 bool 返回值的?——是的,它们可能会失败。


在调试一个项目代码的时候,我就发现了这种失败,观察返回值确实是 false,然而为什么呢?

查看 .NET Framework 的源码 我们发现,CaptureMouse 最终调到了 Mouse.Capture 方法:

1
2
3
4
public static bool Capture(IInputElement element)
{
    return Mouse.PrimaryDevice.Capture(element);
}

然后一步步调到了 bool Capture(IInputElement element, CaptureMode captureMode),而其中对是否可 Capture 的关键性影响代码就在这个方法内部。为了便于理解,我把他改成了下面这样,是等价的:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
[Pure]
private static bool CanCapture(IInputElement element)
{
    if (element is UIElement e)
    {
        return e.IsVisible && e.IsEnabled;
    }
    if (element is ContentElement ce)
    {
        return ce.IsEnabled;
    }
    if (element is UIElement3D e3D)
    {
        return e3D.IsVisible && e3D.IsEnabled;
    }
    return true;
}

这段代码感兴趣可以拿走,以便在 Capture 之前可以进行预判。

从这段代码可以很清楚地知道,如果元素已不可见 (IsVisiblefalse) 或者不可用(IsEnabledfalse),则不可 Capture

以此为线索,果然发现调试的项目中在 MouseDown 事件里把元素隐藏了。

总结:

  • 如果元素不可见或不可用,则 Mouse.Capture 会失败。

顺便还发现一个问题,Stylus.Capture(IInputElement) 中居然直接调用的是 Mouse.Capture(IInputElement)

本文会经常更新,请阅读原文: https://blog.walterlv.com/post/wpf/capture-mouse-failed.html ,以避免陈旧错误知识的误导,同时有更好的阅读体验。

知识共享许可协议

本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。欢迎转载、使用、重新发布,但务必保留文章署名 吕毅 (包含链接: https://blog.walterlv.com ),不得用于商业目的,基于本文修改后的作品务必以相同的许可发布。如有任何疑问,请 与我联系 ([email protected])

登录 GitHub 账号进行评论