ProvideOptionPageAttribute Class

 

Apply this attribute to independent objects to allow users to configure VSPackages through a custom Tools Options page.

Namespace:   Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)


[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true, 
	Inherited = true)]
public sealed class ProvideOptionPageAttribute : ProvideOptionDialogPageAttribute

NameDescription
System_CAPS_pubmethodProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, Int32)

Instantiates a new instance of ProvideOptionPageAttribute.

System_CAPS_pubmethodProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, String)

Instantiates a new instance of ProvideOptionPageAttribute.

System_CAPS_pubmethodProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, String[])

Instantiates a new instance of ProvideOptionPageAttribute.

NameDescription
System_CAPS_pubpropertyCategoryDescriptionResourceId

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.

System_CAPS_pubpropertyCategoryName

Gets the canonical nonlocalized name of the Tools Options page's category.

System_CAPS_pubpropertyCategoryPackageGuid

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").

System_CAPS_pubpropertyCategoryResourceID

Gets the category resource ID for a Tools Options page.

System_CAPS_pubpropertyDescriptionResourceId

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.

System_CAPS_pubpropertyKeywords

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.

System_CAPS_pubpropertyNoShowAllView

Gets or sets whether aggregated Tools Options pages are shown.

System_CAPS_pubpropertyPageName

Gets the canonical nonlocalized name of the Tools Options page.

System_CAPS_pubpropertyPageNameResourceId

Gets the name resource ID of the page.(Inherited from ProvideOptionDialogPageAttribute.)

System_CAPS_pubpropertyPageType

Gets the type of the page.(Inherited from ProvideOptionDialogPageAttribute.)

System_CAPS_pubpropertyProfileMigrationType

Sets the profile migration type.

System_CAPS_pubpropertyProvidesLocalizedCategoryName

Determines whether the package has the localized resources for the category name.

System_CAPS_pubpropertySort

Gets or sets the sort order for the option page. Option pages are collated in the following order:

The General page

Pages with a Sort value, sorted from low to high.

Pages without a Sort value, sorted alphabetically.

System_CAPS_pubpropertySupportsAutomation

Gets whether a Tools Options page implementation supports automation.

System_CAPS_pubpropertySupportsProfiles

Gets or sets whether a Tools Options page implementation uses the Visual Studio settings mechanism to persist its state.

System_CAPS_pubpropertyTypeId

Gets the current instance of ProvideOptionPageAttribute.(Overrides RegistrationAttribute.TypeId.)

System_CAPS_pubpropertyVisibilityCmdUIContexts

Gets or sets 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.

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.

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

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.

System_CAPS_noteNote

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.

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
}

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: