ProvideToolboxPageAttribute Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Package:: Microsoft.VisualStudio.Shell.15.0 v17.11.40262

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.

Registers a VSPackage as providing one or more dialog pages in the Customize Toolbox dialog page of the Visual Studio IDE.

public ref class ProvideToolboxPageAttribute sealed : Microsoft::VisualStudio::Shell::ProvideOptionDialogPageAttribute

public ref class ProvideToolboxPageAttribute sealed : Microsoft::VisualStudio::Shell::ProvideOptionDialogPageAttribute

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

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

Public NotInheritable Class ProvideToolboxPageAttribute
Inherits ProvideOptionDialogPageAttribute

Inheritance: Attribute

RegistrationAttribute

ProvideOptionDialogPageAttribute
ProvideToolboxPageAttribute

Attributes: AttributeUsageAttribute

Remarks

This attribute should be placed only on classes by providing VSPackages by implementing Package.

This attribute is read by the base implementation of the Package class when Visual Studio requests a Customize Toolbox dialog page and maps the request to the class implementing the Customize Toolbox dialog page.

A Customize Toolbox dialog page must be derived from the DialogPage class.

Attribute Context


Applies to	Classes providing VSPackages by implementing IVsPackage or Package.
Repeatable	Yes
Required attributes	None
Invalid attributes	None

Constructors

ProvideToolboxPageAttribute(Type, Int16, Int16, String)	Initializes a new instance of ProvideToolboxPageAttribute, using the Type of the class implementing the Customize Toolbox dialog page, a resource ID, a page order, and a help string.
ProvideToolboxPageAttribute(Type, Int16, Int16)	Initializes a new instance of ProvideToolboxPageAttribute, using the type of the class implementing the Customize Toolbox dialog page, a resource ID, and a page order.
ProvideToolboxPageAttribute(Type, Int16)	Initializes a new instance of ProvideToolboxPageAttribute, using the type of the class implementing the Customize Toolbox dialog page, and a resource ID.

Properties

HelpKeyword	Gets a help keyword associated with the Customize Toolbox dialog page.
PageNameResourceId	Gets the name resource ID of the page. (Inherited from ProvideOptionDialogPageAttribute)
PageOrder	Gets the page order requested for the Customize Toolbox dialog page
PageType	Gets the type of the page. (Inherited from ProvideOptionDialogPageAttribute)
TypeId	Gets the instance of the class implementing the Customize Toolbox dialog page.

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 toolbox page.
Unregister(RegistrationAttribute+RegistrationContext)	Removes the toolbox page registry key.

Applies to

Share via