IVsMethodTipWindow Interface
Provides a method tip window for an item in a language service.
Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)
Syntax
'Déclaration
<InterfaceTypeAttribute()> _
<GuidAttribute("794767F6-538A-4CD3-B29E-6C76C79A7C9C")> _
Public Interface IVsMethodTipWindow _
Inherits IVsTipWindow
[InterfaceTypeAttribute()]
[GuidAttribute("794767F6-538A-4CD3-B29E-6C76C79A7C9C")]
public interface IVsMethodTipWindow : IVsTipWindow
[InterfaceTypeAttribute()]
[GuidAttribute(L"794767F6-538A-4CD3-B29E-6C76C79A7C9C")]
public interface class IVsMethodTipWindow : IVsTipWindow
[<InterfaceTypeAttribute()>]
[<GuidAttribute("794767F6-538A-4CD3-B29E-6C76C79A7C9C")>]
type IVsMethodTipWindow =
interface
interface IVsTipWindow
end
public interface IVsMethodTipWindow extends IVsTipWindow
The IVsMethodTipWindow type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Dismiss() | The window is being dismissed by the view. |
|
Dismiss() | Closes the ToolTip window. (Inherited from IVsTipWindow.) |
|
GetContextStream(Int32%, Int32%) | Returns the context stream. |
|
GetContextStream(Int32%, Int32%) | Returns the position of the text the ToolTip should not obscure and over which the cursor can be held before the ToolTip is closed. (Inherited from IVsTipWindow.) |
|
GetSizePreferences(array<RECT[], array<TIPSIZEDATA[]) | Returns the size preferences for the tip window. |
|
GetSizePreferences(array<RECT[], array<TIPSIZEDATA[]) | Gets the size preferences for the ToolTip window. (Inherited from IVsTipWindow.) |
|
Paint(IntPtr, array<RECT[]) | Paints the tip window. |
|
Paint(IntPtr, array<RECT[]) | Paints the ToolTip window. (Inherited from IVsTipWindow.) |
|
SetMethodData | Sets method data to display in the method tip window and releases previous method data. |
|
WndProc(IntPtr, UInt32, IntPtr, IntPtr) | Method information not provided. Do not use this method. |
|
WndProc(IntPtr, UInt32, IntPtr, IntPtr) | Event handler for the tip window. (Inherited from IVsTipWindow.) |
Top
Remarks
Call this interface from your language service to provide method tips based on what the user is typing in the core editor. To intercept user characters, your language service object must also implement IOleCommandTarget. To pass the text view a pointer to your IOleCommandTarget implementation, call AddCommandFilter. The command filter intercepts commands that the user types into the code window. Monitor the command information to know when to display method tip information to the user.
The method tip window provides users with hints about where they are in a language construct. When the user types a keyword that the language service can provide hints on, the language service creates an IVsMethodTipWindow object and calls UpdateTipWindow to notify the view that it's time to provide a hint. Create IVsMethodTipWindow using VsLocalCreateInstance and specifying the coclass CLSID_VsMethodTipWindow. VsLocalCreateInstance is a function defined in vsdoc.h that calls QueryService for the local registry and calls CreateInstance on this object for the CLSID_VsMethodTipWindow.
Use IVsTipWindow to provide a generic tip to the user.
See illustrations of the implementation and/or calling of this interface in the sample Figures Language Service.
Notes to Implementers
Implemented by the core text editor to provide a method tip window.