ProvideProfileAttribute 类

定义

public ref class ProvideProfileAttribute sealed : Microsoft::VisualStudio::Shell::RegistrationAttribute

public ref class ProvideProfileAttribute sealed : Microsoft::VisualStudio::Shell::RegistrationAttribute

[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)]
public sealed class ProvideProfileAttribute : Microsoft.VisualStudio.Shell.RegistrationAttribute

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)>]
type ProvideProfileAttribute = class
    inherit RegistrationAttribute

Public NotInheritable Class ProvideProfileAttribute
Inherits RegistrationAttribute

继承

Attribute

RegistrationAttribute

ProvideProfileAttribute

属性

AttributeUsageAttribute

示例

在下面的示例中， 的 ProvideProfileAttribute 两个实例应用于 VSPackage 实现，以定义这两个类，为类 MyPackage实现的 VSPackage 提供 Visual Studio 设置支持。

1. 由于名为“DesignerOptionsPage”的页面的实现派生自 DialogPage，因此它可以支持 Visual Studio 设置和 “工具选项” 页，并且注册为同时提供：

   • “工具选项”页的实现，该页通过 实例 ProvideOptionPageAttribute注册。 有关支持 “工具选项” 页的详细信息，请参阅 ProvideOptionPageAttribute。

   • 支持持久保存 “工具选项” 页的状态的实现，该状态由构造函数的最后一个参数 ProvideProfileAttribute 指示。

2. 名为“PersistedDesignerState”的类注册为仅提供 Visual Studio 设置支持，通过实现 IProfileManager保存和检索名为“MyPackage”的 VSPackage 的剩余状态信息。

using Microsoft.VisualStudio.Shell;  
namespace Example  
{  
[DefaultRegistryRoot("Software\\Microsoft\\VisualStudio\\8.0")]   
[ProvideOptionPage(typeof(DesignerOptionsPage), "MyDesigner", "OptionPage", 1000, 1001, true)]   
[ProvideProfileAttribute(typeof(DesignerOptionsPage), "MyDesigner", "OptionPage", 1002, 1003, true)]  
[ProvideProfileAttribute(typeof(PersistCurrentDesign), "MyDesigner","CurrentDesign", 1004, 1005, false)]  
[Guid("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")]  
public class MyPackage : Package  
{  
//Implementation here  
}  

[Guid("YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY")]  
internal class DesignerOptionsPage: DialogPage {  
//Implementation here  
}  

[Guid("ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ")]  
internal class PersistCurrentDesign: IProfileManager {  
//Implementation here  
}  

注解

对调用者的说明

ProvideProfileAttribute当存在实现 VSPackage 的 Visual Studio 设置功能的类时，将 特性应用于实现 VSPackage 的类，从而允许它保存和检索 VSPackage 状态信息。

特性上下文

实现者须知

此属性仅用于注册目的，不会影响运行时行为。

ProvideProfileAttribute 注册实现 IProfileManager 或 DialogPage 的类，以提供通过 Visual Studio 设置机制保留部分或全部 VSPackage 状态的支持。 实现类保留的状态信息称为 Visual Studio 设置类别，其定义项在注册表中称为自定义设置点。

当用户选择“工具”菜单上的“导入/导出设置”命令以保存 Visual Studio 设置时，由 注册ProvideProfileAttribute的类将由 IDE 实例化并用于保存设置。

因此：

• Visual Studio 设置支持应在其自己的对象上实现，而不是在 VSPackage 本身上实现。

• 实现 Visual Studio 设置的类可能仅支持自定义设置点中定义的一个 Visual Studio 设置类别。

但是，只要定义了多个自定义设置点，单个 VSPackage 就可能支持多个 Visual Studio 设置类别：

• 每个 Visual Studio 设置类别在单独的类中实现。

• 实现 Visual Studio 设置的每个类都通过其自己的 实例 ProvideProfileAttribute注册为支持 VSPackage。

  注意

  这不同于基于 COM 的实现，其中实现 Visual Studio 设置的类可能支持多个自定义设置点。

的 ProvideProfileAttribute实例：

• 使用从 Type 实现 Visual Studio 设置的 类的 获取的 GUID 唯一标识自定义设置点的 Visual Studio 设置类别。

• 设置 Visual Studio 设置类别的名称，包括注册表项中使用的规范的非本地化名称及其本地化名称资源。

• 指示支持类实现的 ProvideProfileAttribute Visual Studio 设置是否支持 “工具选项” 页 (有关支持 “工具选项” 页的详细信息，请参阅 选项页) 。

有关创建和应用 实例的详细信息 ProvideProfileAttribute，请参阅以下示例 和 ProvideProfileAttribute。