ProvideToolboxPageAttribute Constructors

Definition

Namespace:

Microsoft.VisualStudio.Shell

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.11.40262

Overloads

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.

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.

public:
 ProvideToolboxPageAttribute(Type ^ pageType, short nameResourceID);

public:
 ProvideToolboxPageAttribute(Platform::Type ^ pageType, short nameResourceID);

public ProvideToolboxPageAttribute (Type pageType, short nameResourceID);

new Microsoft.VisualStudio.Shell.ProvideToolboxPageAttribute : Type * int16 -> Microsoft.VisualStudio.Shell.ProvideToolboxPageAttribute

Public Sub New (pageType As Type, nameResourceID As Short)

Parameters

pageType

Type

[in] The Type of the class implementing the Customize Toolbox dialog page. This type must derive from the DialogPage class.

nameResourceID

Int16

[in] The native resource ID in a VSPackage's satellite dll containing the name for the tab hosting this Customize Toolbox dialog page.

Examples

This example shows how to register the Customize Toolbox dialog page implementation MyToolBoxPage as being provided by MyPackage. The name resource of the tab containing the page is 1002.

[ProvideToolboxPage(typeof(VsToolboxPage), 1002)]  
[Guid("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")]  
class VSCorePackage : Package  

Remarks

This method returns ArgumentException if pageType does not inherit from the DialogPage class.

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.

public:
 ProvideToolboxPageAttribute(Type ^ pageType, short nameResourceID, short pageOrder);

public:
 ProvideToolboxPageAttribute(Platform::Type ^ pageType, short nameResourceID, short pageOrder);

public ProvideToolboxPageAttribute (Type pageType, short nameResourceID, short pageOrder);

new Microsoft.VisualStudio.Shell.ProvideToolboxPageAttribute : Type * int16 * int16 -> Microsoft.VisualStudio.Shell.ProvideToolboxPageAttribute

Public Sub New (pageType As Type, nameResourceID As Short, pageOrder As Short)

Parameters

pageType

Type

[in] The type of the class implementing the Customize Toolbox dialog page. This type must derive from the DialogPage class.

nameResourceID

Int16

[in] The native resource ID in a VSPackage's satellite dll containing the name for the tab of hosting this Customize Toolbox dialog page.

pageOrder

Int16

[in] The Customize Toolbox dialog page placement in the pages of the Visual Studio Customize Toolbox Dialog. A value of 0 indicates that no order is requested.

Examples

This example shows how to register the Customize Toolbox dialog page implementation MyToolBoxPage as being provided by MyPackage. The name resource of the tab containing the page is 1002, page order of the page is 1 (indicating that it should be placed first).

[ProvideToolboxPage(typeof(VsToolboxPage), 1002, 1 )]  
[Guid("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")]  
class VSCorePackage : Package  

Remarks

This method returns ArgumentException if pageType does not inherit from the DialogPage class.

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.

public:
 ProvideToolboxPageAttribute(Type ^ pageType, short nameResourceID, short pageOrder, System::String ^ helpKeyword);

public:
 ProvideToolboxPageAttribute(Platform::Type ^ pageType, short nameResourceID, short pageOrder, Platform::String ^ helpKeyword);

public ProvideToolboxPageAttribute (Type pageType, short nameResourceID, short pageOrder, string helpKeyword);

new Microsoft.VisualStudio.Shell.ProvideToolboxPageAttribute : Type * int16 * int16 * string -> Microsoft.VisualStudio.Shell.ProvideToolboxPageAttribute

Public Sub New (pageType As Type, nameResourceID As Short, pageOrder As Short, helpKeyword As String)

Parameters

pageType

Type

[in] The type of the class implementing the Customize Toolbox dialog page. This type must derive from the DialogPage class.

nameResourceID

Int16

[in] The native resource ID in a VSPackage's satellite dll containing the name for the tab of hosting this Customize Toolbox dialog page.

pageOrder

Int16

[in] The Customize Toolbox dialog page placement in the pages of the Visual Studio Customize Toolbox Dialog box. A value of zero indicates that no order is requested.

helpKeyword

String

[in] A help keyword used by the help system to find the correct help topic information.

Examples

This example shows how to register the Customize Toolbox dialog page implementation MyToolBoxPage as being provided by MyPackage. The name resource of the tab containing the page is 1002, page order of the page is 1 (indicating that it should be placed first), and a help keyword of "MyToolboxDialog".

[ProvideToolboxPage(typeof(VsToolboxPage), 1002, 1 , "MyToolboxDialog")]  
[Guid("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")]  
class VSCorePackage : Package  

Remarks

This method throws ArgumentException if pageType does not inherit from the DialogPage class.

It is up to the implementer to ensure that the provided keyword is integrated into the help indexing system.