ProvideToolboxPageAttribute Class
Registers a VSPackage as providing one or more dialog pages in the Customize Toolbox dialog page of the Visual Studio IDE.
Inheritance Hierarchy
Object
Attribute
Microsoft.VisualStudio.Shell.RegistrationAttribute
Microsoft.VisualStudio.Shell.ProvideOptionDialogPageAttribute
Microsoft.VisualStudio.Shell.ProvideToolboxPageAttribute
Namespace: Microsoft.VisualStudio.Shell
Assembly: Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)
Syntax
'Declaration
<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple := True, Inherited := True)> _
Public NotInheritable Class ProvideToolboxPageAttribute _
Inherits ProvideOptionDialogPageAttribute
[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true, Inherited = true)]
public sealed class ProvideToolboxPageAttribute : ProvideOptionDialogPageAttribute
[AttributeUsageAttribute(AttributeTargets::Class, AllowMultiple = true, Inherited = true)]
public ref class ProvideToolboxPageAttribute sealed : public ProvideOptionDialogPageAttribute
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true, Inherited = true)>]
type ProvideToolboxPageAttribute =
class
inherit ProvideOptionDialogPageAttribute
end
public final class ProvideToolboxPageAttribute extends ProvideOptionDialogPageAttribute
The ProvideToolboxPageAttribute type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
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. |
|
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, 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. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
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. (Overrides RegistrationAttribute.TypeId.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.) |
|
GetHashCode | Returns the hash code for this instance. (Inherited from Attribute.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
IsDefaultAttribute | When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.) |
|
Match | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.) |
|
Register | Registers the toolbox page. (Overrides RegistrationAttribute.Register(RegistrationAttribute.RegistrationContext).) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
Unregister | Removes the toolbox page registry key. (Overrides RegistrationAttribute.Unregister(RegistrationAttribute.RegistrationContext).) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
System#Runtime#InteropServices#_Attribute#GetIDsOfNames | Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.) |
|
System#Runtime#InteropServices#_Attribute#GetTypeInfo | Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.) |
|
System#Runtime#InteropServices#_Attribute#GetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.) |
|
System#Runtime#InteropServices#_Attribute#Invoke | Provides access to properties and methods exposed by an object. (Inherited from Attribute.) |
Top
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 |
Notes to Callers
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.