IVsToolboxDataProvider2.GetItemTipInfo Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Supplies ToolTip data for a Toolbox item.

public:
 int GetItemTipInfo(Microsoft::VisualStudio::OLE::Interop::IDataObject ^ pDO, System::String ^ lpszCurrentName, Microsoft::VisualStudio::OLE::Interop::IPropertyBag ^ pStrings);

public:
 int GetItemTipInfo(Microsoft::VisualStudio::OLE::Interop::IDataObject ^ pDO, Platform::String ^ lpszCurrentName, Microsoft::VisualStudio::OLE::Interop::IPropertyBag ^ pStrings);

int GetItemTipInfo(Microsoft::VisualStudio::OLE::Interop::IDataObject const & pDO, std::wstring const & lpszCurrentName, Microsoft::VisualStudio::OLE::Interop::IPropertyBag const & pStrings);

public int GetItemTipInfo (Microsoft.VisualStudio.OLE.Interop.IDataObject pDO, string lpszCurrentName, Microsoft.VisualStudio.OLE.Interop.IPropertyBag pStrings);

abstract member GetItemTipInfo : Microsoft.VisualStudio.OLE.Interop.IDataObject * string * Microsoft.VisualStudio.OLE.Interop.IPropertyBag -> int

Public Function GetItemTipInfo (pDO As IDataObject, lpszCurrentName As String, pStrings As IPropertyBag) As Integer

Parameters

pDO

IDataObject

[in] The data object corresponding to the Toolbox item.

lpszCurrentName

String

[in] The name of the Toolbox item as it is currently displayed on the Toolbox.

pStrings

IPropertyBag

[in] The COM object IPropertyBag object containing the values that the ToolTip should display.

Returns

Int32

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

Remarks

COM Signature

From vsshell80.idl:

HRESULT IVsToolboxDataProvider2::GetItemTipInfo(  
   [in] IDataObject *pDO,  
   [in] LPCOLESTR lpszCurrentName,  
   [in] IPropertyBag *pStrings  
);  

lpszCurrentName is the current display name of the item as it exists on the Toolbox (which may be different from its original name if the user has renamed it).

The data provider can add a value to an item's ToolTip window by calling Write once for each property. The following property names are recognized:

Name	Value
"Name"	"Name" can be any string, but in most cases it should be the same as lpszCurrentName. (The value of "Name" will be displayed in bold.)
"Version"	A string containing a series of numbers separated by periods (e.g. "1.2.34").
"Company"	A string containing the name of the company.
"ComponentType"	A string that describes the type of the component, such as "Managed .NET Control" or "COM Component".
"Description"	A string containing one or two sentences of less than 100 total characters.

Any, all, or none of these properties may be supplied to the Write method.