IVsToolbox2.AddTab2(String, Guid) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Adds a tab to the Toolbox, specifying the tab view.

public:
 int AddTab2(System::String ^ lpszTab, Guid % guidPkg);

public int AddTab2 (string lpszTab, ref Guid guidPkg);

abstract member AddTab2 : string * Guid -> int

Public Function AddTab2 (lpszTab As String, ByRef guidPkg As Guid) As Integer

Parameters

lpszTab

String

[in] The localized name of the tab to add to the Toolbox. The localized name can be obtained from the invariant non-localized name by calling GetIDOfTab(String, String).

guidPkg

Guid

[in] Package GUID identifying your VSPackage.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsToolbox2::AddTab2(  
   [in]LPCOLESTR lpszTab,  
   [in]REFGUID guidPkg  
);  

The Toolbox uses the Package GUID to set the UI text for your Toolbox item. In the bstrText element of the TBXITEMINFO Structure, you should specify a resource ID of the form "#number". This resource ID must then correspond to the UI string for the Toolbox item in your satellite DLL. The Toolbox persists the package GUID and resource ID for each Toolbox item. This enables it to reassign each Toolbox UI string in the event that the user changes the environment language (locale).

Note

If you specify the name of a tab that has already been added, then this method returns E_FAIL.