VS新扩展模型：如何添加扩展配置页面？旧实现已失效

数据老陈

2026-6-26

新VS扩展模型中添加设置页面的正确方法

旧模型里的DialogPage、ProvideProfileAttribute这类API在新VS扩展模型（基于VS Extensibility SDK）中已不再适用，以下是正确的实现方式：

1. 定义设置类

创建带有SettingsDefinition特性的设置类，每个配置项用Setting特性标记：

using Microsoft.VisualStudio.Extensibility.Settings;

[SettingsDefinition(
    DisplayName = "Extension Name",
    Description = "配置扩展的通用设置",
    Scope = SettingsScope.User)]
internal partial class ExtensionSettings
{
    [Setting(
        DisplayName = "Access Key:",
        Description = "输入你的服务访问密钥",
        DefaultValue = "")]
    public string AccessKey { get; set; } = string.Empty;
}

2. 创建设置页面

继承SettingsPage类并通过VisualStudioContribution特性注册，关联上面定义的设置类：

using Microsoft.VisualStudio.Extensibility;
using Microsoft.VisualStudio.Extensibility.Settings;

[VisualStudioContribution]
internal class GeneralSettingsPage : SettingsPage
{
    public GeneralSettingsPage(VisualStudioExtensibility extensibility)
        : base(extensibility)
    {
    }

    // 设置页面在扩展设置中的标题
    public override string Title => "General";

    // 关联对应的设置定义类型
    public override Type SettingsDefinitionType => typeof(ExtensionSettings);
}

3. 扩展入口类

保持入口类继承Extension即可，无需额外的旧特性：

using Microsoft.VisualStudio.Extensibility;

[VisualStudioContribution]
internal class ExtensionEntrypoint : Extension
{
    public override Task InitializeAsync(CancellationToken cancellationToken)
    {
        // 可在此添加扩展初始化逻辑（如注册命令等）
        return base.InitializeAsync(cancellationToken);
    }
}