DocumentTask.GetTipText Method

Gets the tip text for the text marker that is displayed when the mouse hovers over the marker.

Namespace: Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
  Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)

Syntax

'Declaration
Public Overridable Function GetTipText ( _
    marker As IVsTextMarker, _
    tipText As String() _
) As Integer
'Usage
Dim instance As DocumentTask
Dim marker As IVsTextMarker
Dim tipText As String()
Dim returnValue As Integer

returnValue = instance.GetTipText(marker, _
    tipText)

public virtual int GetTipText(
    IVsTextMarker marker,
    string[] tipText
)

public:
virtual int GetTipText(
    IVsTextMarker^ marker, 
    array<String^>^ tipText
)

abstract GetTipText : 
        marker:IVsTextMarker * 
        tipText:string[] -> int 
override GetTipText : 
        marker:IVsTextMarker * 
        tipText:string[] -> int

public function GetTipText(
    marker : IVsTextMarker, 
    tipText : String[]
) : int

Parameters

marker
Type: Microsoft.VisualStudio.TextManager.Interop.IVsTextMarker
The marker for which to get the text.

tipText
Type: array<System.String[]
The text to display.

Return Value

Type: System.Int32
The text of this task.

Implements

IVsTextMarkerClient.GetTipText(IVsTextMarker, array<String[])

Remarks

This method sets tipText to the text of this task. It is an implementation of GetTipText.

.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.