实现IValueProvider的UserControl致Visual Studio设计器崩溃求助

问题背景 #

自定义WinForms UserControl实现IValueProvider和IRawElementProviderSimple接口以支持UI测试需求，运行时功能正常，但在Visual Studio窗体设计器中添加或编辑该控件属性时，VS因UIAutomationCore.dll触发崩溃。使用.NET Framework 4.8，尝试interop.UIAutomationCore NuGet包后问题未解决。

核心原因分析 #

1. 属性递归调用：required属性的getter直接返回自身，引发无限递归栈溢出，是触发崩溃的直接诱因之一。
2. 设计模式下未隔离UIA逻辑：Visual Studio设计器会通过UIA扫描控件元数据，自定义UIA提供者的COM交互逻辑与设计器线程模型冲突，导致崩溃。
3. ProviderOptions配置冲突：UseComThreading选项强制使用COM线程模型，在设计器环境下易引发线程同步问题。

解决方案 #

1. 修复递归属性问题 #

将required属性改为私有字段存储状态，避免无限递归：

private bool _required;
public bool required
{
    get => _required;
    set
    {
        _required = value;
        // 避免重复添加星号
        label1.Text = value ? $"{label}*" : label;
    }
}

2. 设计模式下禁用UIA逻辑 #

在WndProc中判断当前是否处于设计模式，若是则跳过UIA相关消息处理：

protected override void WndProc(ref Message m)
{
    if (LicenseManager.UsageMode == LicenseUsageMode.Designtime)
    {
        base.WndProc(ref m);
        return;
    }

    switch (m.Msg)
    {
        case NativeUIA.WM_GETOBJECT:
            if (m.LParam == NativeUIA.UiaRootObjectId)
            {
                m.Result = NativeUIA.UiaReturnRawElementProvider(this.Handle, m.WParam, m.LParam, this);
                return;
            }
            break;
    }

    base.WndProc(ref m);
}

3. 调整ProviderOptions配置 #

移除UseComThreading选项，仅保留ServerSideProvider，避免线程模型冲突：

public ProviderOptions ProviderOptions
{
    get
    {
        return ProviderOptions.ServerSideProvider;
    }
}

4. 安全获取Host提供者 #

在设计模式下避免通过控件句柄获取Host提供者，防止无效句柄引发异常：

public IRawElementProviderSimple HostRawElementProvider
{
    get
    {
        if (LicenseManager.UsageMode == LicenseUsageMode.Designtime)
        {
            return null;
        }
        return AutomationInteropProvider.HostProviderFromHandle(this.Handle);
    }
}

修改后的完整代码 #

using System;
using System.ComponentModel;
using System.Windows.Automation;
using System.Windows.Automation.Provider;
using System.Windows.Forms;

namespace WindowsFormsApp1
{
    public partial class UserControl1 : UserControl, IValueProvider, IRawElementProviderSimple
    {
        private bool _required;

        protected override void WndProc(ref Message m)
        {
            if (LicenseManager.UsageMode == LicenseUsageMode.Designtime)
            {
                base.WndProc(ref m);
                return;
            }

            switch (m.Msg)
            {
                case NativeUIA.WM_GETOBJECT:
                    if (m.LParam == NativeUIA.UiaRootObjectId)
                    {
                        m.Result = NativeUIA.UiaReturnRawElementProvider(this.Handle, m.WParam, m.LParam, this);
                        return;
                    }
                    break;
            }

            base.WndProc(ref m);
        }

        public string label
        {
            get => label1.Text;
            set => label1.Text = value;
        }

        public bool required
        {
            get => _required;
            set
            {
                _required = value;
                label1.Text = value ? $"{label}*" : label;
            }
        }

        public UserControl1()
        {
            InitializeComponent();
        }

        public string Value { get; set; }
        public bool IsReadOnly => true;

        public void SetValue(string value)
        {
            // 空实现保持不变
        }

        public object GetPatternProvider(int patternId)
        {
            return patternId == ValuePatternIdentifiers.Pattern.Id ? this : null;
        }

        public object GetPropertyValue(int propertyId)
        {
            if (propertyId == AutomationElementIdentifiers.NameProperty.Id)
            {
                return this.Name;
            }
            else if (propertyId == AutomationElementIdentifiers.LocalizedControlTypeProperty.Id)
            {
                return "custom control";
            }

            return null;
        }

        public IRawElementProviderSimple HostRawElementProvider
        {
            get
            {
                if (LicenseManager.UsageMode == LicenseUsageMode.Designtime)
                {
                    return null;
                }
                return AutomationInteropProvider.HostProviderFromHandle(this.Handle);
            }
        }

        public ProviderOptions ProviderOptions
        {
            get
            {
                return ProviderOptions.ServerSideProvider;
            }
        }
    }

    public class NativeUIA
    {
        [System.Runtime.InteropServices.DllImport("UIAutomationCore.dll", EntryPoint = "UiaReturnRawElementProvider", CharSet = System.Runtime.InteropServices.CharSet.Unicode)]
        public static extern IntPtr UiaReturnRawElementProvider(
            IntPtr hwnd, IntPtr wParam, IntPtr lParam, IRawElementProviderSimple el);

        public const int WM_GETOBJECT = 0x003D;
        public static IntPtr UiaRootObjectId = (IntPtr)(-25);
    }
}

内容的提问来源于stack exchange，提问作者Kozel Czech