IVsMethodTipWindow Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides a method tip window for an item in a language service.

public interface class IVsMethodTipWindow : Microsoft::VisualStudio::TextManager::Interop::IVsTipWindow

public interface class IVsMethodTipWindow : Microsoft::VisualStudio::TextManager::Interop::IVsTipWindow

__interface IVsMethodTipWindow : Microsoft::VisualStudio::TextManager::Interop::IVsTipWindow

[System.Runtime.InteropServices.Guid("794767F6-538A-4CD3-B29E-6C76C79A7C9C")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsMethodTipWindow : Microsoft.VisualStudio.TextManager.Interop.IVsTipWindow

[System.Runtime.InteropServices.Guid("794767F6-538A-4CD3-B29E-6C76C79A7C9C")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsMethodTipWindow : Microsoft.VisualStudio.TextManager.Interop.IVsTipWindow

[<System.Runtime.InteropServices.Guid("794767F6-538A-4CD3-B29E-6C76C79A7C9C")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsMethodTipWindow = interface
    interface IVsTipWindow

[<System.Runtime.InteropServices.Guid("794767F6-538A-4CD3-B29E-6C76C79A7C9C")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsMethodTipWindow = interface
    interface IVsTipWindow

Public Interface IVsMethodTipWindow
Implements IVsTipWindow

Derived: Microsoft.VisualStudio.TextManager.Interop.VsMethodTipWindow

Microsoft.VisualStudio.TextManager.Interop.VsMethodTipWindowClass

Attributes: GuidAttribute InterfaceTypeAttribute

Implements: IVsTipWindow

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.

Methods

Dismiss()	The window is being dismissed by the view.
GetContextStream(Int32, Int32)	Returns the context stream.
GetSizePreferences(RECT[], TIPSIZEDATA[])	Returns the size preferences for the tip window.
Paint(IntPtr, RECT[])	Paints the tip window.
SetMethodData(IVsMethodData)	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.

Applies to

Partager via