This documentation is archived and is not being maintained.

ViewFilter.GetFullDataTipText Method

Returns a string that can be used in a tool tip, taking into account additional sources of text such as a debugger.

This method is not CLS-compliant.  

Namespace: Microsoft.VisualStudio.Package
Assembly: Microsoft.VisualStudio.Package.LanguageService (in microsoft.visualstudio.package.languageservice.dll)

public virtual int GetFullDataTipText (
	string textValue,
	TextSpan ts,
	out string fullTipText
)
public int GetFullDataTipText (
	String textValue, 
	TextSpan ts, 
	/** @attribute OutAttribute() */ /** @ref */ String fullTipText
)
JScript does not support passing value-type arguments by reference.

Parameters

textValue

[in] The string to use as the default.

ts

[in] A TextSpan object specifying the span of source to examine.

fullTipText

[out] Returns a string to be used as a tool tip.

Return Value

If successful, returns S_OK; otherwise, returns an error code. Other possible success codes are TIP_S_NODEFAULTTIP (only the value returned from the debugger is used) and TIP_S_ONLYIFNOMARKER (show the tool tip only if no parsing errors have occurred in the same location).

This method is called to make the final adjustments to the given text to be displayed in a tool tip. These adjustments take into account other sources of information such as a debugger. This additional information is then either combined with the default text or replaces the default text before the text is returned.

The base method determines if a debugger is running and if so, gets the extent of the expression the cursor is over by calling the GetWordExtent method with the flag WORDEXT_FINDEXPRESSION. The resulting TextSpan object is then passed to the GetDataTipValue method on the IVsDebugger interface representing the debugger. If GetDataTipValue returns a valid string, this string either replaces the default string specified by textValue or is appended to the default string (the debugger string replaces the default string if GetDataTipValue returns TIP_S_NODEFAULTTIP.

If the debugger is not running or there was no expression to pass to the debugger, the value in textValue is returned in fullTipText.

In the default managed package framework's implementation of the language service classes, this method is called from the GetDataTipText and HandleQuickInfo methods.

Show: