IVsToolboxDataProvider2.GetItemTipInfo Method

  • [アーティクル]

Supplies ToolTip data for a Toolbox item.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

'宣言
Function GetItemTipInfo ( _
    pDO As IDataObject, _
    lpszCurrentName As String, _
    pStrings As IPropertyBag _
) As Integer
'使用
Dim instance As IVsToolboxDataProvider2
Dim pDO As IDataObject
Dim lpszCurrentName As String
Dim pStrings As IPropertyBag
Dim returnValue As Integer

returnValue = instance.GetItemTipInfo(pDO, _
    lpszCurrentName, pStrings)

int GetItemTipInfo(
    IDataObject pDO,
    string lpszCurrentName,
    IPropertyBag pStrings
)

int GetItemTipInfo(
    [InAttribute] IDataObject^ pDO, 
    [InAttribute] String^ lpszCurrentName, 
    [InAttribute] IPropertyBag^ pStrings
)

function GetItemTipInfo(
    pDO : IDataObject, 
    lpszCurrentName : String, 
    pStrings : IPropertyBag
) : int

Parameters

  • lpszCurrentName
    Type: System.String

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

Return Value

Type: System.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.

Permissions

See Also

Reference

IVsToolboxDataProvider2 Interface

IVsToolboxDataProvider2 Members

Microsoft.VisualStudio.Shell.Interop Namespace