IVsHiddenTextClient.GetTipText Method

Article
03/11/2013

Signals that the user has hovered the mouse over a collapsed hidden text region.

Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

'Declaration
Function GetTipText ( _
    pHidReg As IVsHiddenRegion, _
    <OutAttribute> pbstrText As String() _
) As Integer

int GetTipText(
    IVsHiddenRegion pHidReg,
    string[] pbstrText
)

int GetTipText(
    [InAttribute] IVsHiddenRegion^ pHidReg, 
    [OutAttribute] array<String^>^ pbstrText
)

abstract GetTipText : 
        pHidReg:IVsHiddenRegion * 
        pbstrText:string[] byref -> int

function GetTipText(
    pHidReg : IVsHiddenRegion, 
    pbstrText : String[]
) : int

Parameters

pHidReg
Type: Microsoft.VisualStudio.TextManager.Interop.IVsHiddenRegion
[in] Pointer to a hidden region object, IVsHiddenRegion for which tip text is required.

pbstrText
Type: array<System.String[]
[out] Pointer to a string containing the tip text.

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 textmgr.idl:

HRESULT IVsHiddenTextClient::GetTipText(
   [in] IVsHiddenRegion *pHidReg, 
   [out, optional] BSTR *pbstrText
);

Provides tip text for the collapsed outline region in response to this method being called. For example, in Visual C#, this method is used to provide the text of comments when they are collapsed and the user hovers over the banner for the collapsed region (that is, "/**/").

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via