ProvideOptionPageAttribute Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Apply this attribute to independent objects to allow users to configure VSPackages through a custom Tools Options page.
public ref class ProvideOptionPageAttribute sealed : Microsoft::VisualStudio::Shell::ProvideOptionDialogPageAttributepublic ref class ProvideOptionPageAttribute sealed : Microsoft::VisualStudio::Shell::ProvideOptionDialogPageAttribute[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)]
public sealed class ProvideOptionPageAttribute : Microsoft.VisualStudio.Shell.ProvideOptionDialogPageAttribute[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)>]
type ProvideOptionPageAttribute = class
inherit ProvideOptionDialogPageAttributePublic NotInheritable Class ProvideOptionPageAttribute
Inherits ProvideOptionDialogPageAttribute- Inheritance
- Attributes
Examples
In the example below, an instance of ProvideOptionPageAttribute is applied to a VSPackage implementation to register the class DesignerOptionsPage, which is derived from DialogPage, as providing the VSPackage with a Tools Options page.
Classes derived from DialogPage are provided with a default implementation of Visual Studio settings functionality, which can be overridden. The IDE makes use of this Visual Studio settings support if, as in the example, ProvideProfileAttribute is applied to the VSPackage implementation. For more information on Visual Studio settings support, see Extending User Settings and Options.
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
}
Remarks
Notes for Implementers
Apply the ProvideOptionPageAttribute to classes implementing a VSPackage. This attribute enables to register that a specific independent object provides the VSPackage's users with configuration access through a custom Tools Options page.
Attribute Context
| Applies to | VSPackages allow configuration through custom Tools Options pages implemented either through the Managed Package Framework's DialogPage or by using the Visual Studio SDK code. |
| Repeatable | Yes |
| Required attributes | DefaultRegistryRootAttribute |
| Invalid attributes | None |
Notes for Callers
This attribute is used only for registration purposes and does not affect the runtime behavior of the code.
The ProvideOptionPageAttribute registers a given class implementing IProfileManager or DialogPage as providing a particular VSPackage support for persisting part or all of VSPackage's state through the Visual Studio settings mechanism. The state information persisted by the implementing class is referred to as a Visual Studio settings category and its defining entry in the registry is referred to as a Custom Settings Point.
Note
When a Managed Package Framework based custom Tools Options page is loaded, the IDE instantiates the object registered by ProvideOptionPageAttribute as implementing it. Managed Package Framework Tools Options page support should be implemented on its own object and not on the VSPackage itself.
For more information on creating and applying instances of ProvideOptionPageAttribute, see the example below and ProvideOptionPageAttribute.
Constructors
| ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, Int32) |
Instantiates a new instance of ProvideOptionPageAttribute. |
| ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, String) |
Instantiates a new instance of ProvideOptionPageAttribute. |
| ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, String[]) |
Instantiates a new instance of ProvideOptionPageAttribute. |
Properties
| CategoryDescriptionResourceId |
The ID of a resource containing the localized description of the page's parent category. This property is only used if SupportsAutomation == true and SupportsProfiles == true. The localized description appears in the import/export settings wizard. |
| CategoryName |
Gets the canonical nonlocalized name of the Tools Options page's category. |
| CategoryPackageGuid |
The ID of the package that owns the category under which this page is registered. If this is not set, the package is assumed to be the one to which this attribute is applied. This property is only used if SupportsAutomation == true and SupportsProfiles == true. Generate this from a Guid with Guid.ToString("B"). |
| CategoryResourceID |
Gets the category resource ID for a Tools Options page. |
| DescriptionResourceId |
The ID of a resource containing the localized description of the page. This property is only used if SupportsAutomation == true and SupportsProfiles == true. The localized description appears in the import/export settings wizard. |
| IsInUnifiedSettings |
Gets or sets a value indicating whether the settings in this page have been onboarded to Unified Settings through the creation of new registration. If true, the page is hidden when Unified Settings is enabled so its settings aren't duplicated. |
| IsServerAware |
Gets or sets a value indicating whether the UI of this page shows settings that are synchronized with the server in a connected client-server scenario by using ISettingsManager3 or an API with similar functionality. |
| Keywords |
Gets the searchable keywords for this options page. Each keyword may be a literal string, a resource name/ID (prefixed with "@"/"#") pointing to a single keyword, or a resource name/ID (prefixed with "@"/"#") pointing to a semicolon-delimited list of keywords. |
| NoShowAllView |
Gets or sets whether aggregated Tools Options pages are shown. |
| PageName |
Gets the canonical nonlocalized name of the Tools Options page. |
| PageNameResourceId |
Gets the name resource ID of the page. (Inherited from ProvideOptionDialogPageAttribute) |
| PageType |
Gets the type of the page. (Inherited from ProvideOptionDialogPageAttribute) |
| ProfileMigrationType |
Sets the profile migration type. |
| ProvidesLocalizedCategoryName |
Determines whether the package has the localized resources for the category name. |
| Sort |
The sort order for the option page. Option pages are collated in the following order: |
| SupportsAutomation |
Gets whether a Tools Options page implementation supports automation. |
| SupportsProfiles |
Gets or sets whether a Tools Options page implementation uses the Visual Studio settings mechanism to persist its state. |
| TypeId |
Gets the current instance of ProvideOptionPageAttribute. |
| UnifiedSettingsCategoryMoniker |
For pages with IsInUnifiedSettings = false, gets or sets the moniker of the parent category in the Unified Settings hierarchy. This can be a moniker that already exists, or one that exists plus one additional '.'-delimited segment. If the latter, a new category named by CategoryResourceID is created in the Unified Settings hierarchy and this page is inserted in it. Otherwise, this page is inserted under the existing category. |
| VisibilityCmdUIContexts |
A semi-colon-delimited list of UIContext GUIDs. The option page is visible when any UIContext in the list is active. If this is not specified, the option page is always visible. |
Methods
| GetPackageRegKeyPath(Guid) |
Gets the registry path (relative to the registry root of the application) of the VSPackage. (Inherited from RegistrationAttribute) |
| Register(RegistrationAttribute+RegistrationContext) |
Registers the Tools Options page. |
| Unregister(RegistrationAttribute+RegistrationContext) |
Removes the Tools Options page key from the registry. |