IVsTipWindow Interface

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.TextManager.Interop
Assembly:
Microsoft.VisualStudio.TextManager.Interop.dll
Assembly:
Microsoft.VisualStudio.Interop.dll
Package:
Microsoft.VisualStudio.Interop v17.11.40262

Provides a tip when the mouse pauses over a particular context stream in the core editor.

public interface class IVsTipWindow
public interface class IVsTipWindow
__interface IVsTipWindow
[System.Runtime.InteropServices.ComConversionLoss]
[System.Runtime.InteropServices.Guid("64C7FFC4-B9EE-4599-B130-FF9D890ECFD4")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsTipWindow
[System.Runtime.InteropServices.ComConversionLoss]
[System.Runtime.InteropServices.Guid("64C7FFC4-B9EE-4599-B130-FF9D890ECFD4")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsTipWindow
[<System.Runtime.InteropServices.ComConversionLoss>]
[<System.Runtime.InteropServices.Guid("64C7FFC4-B9EE-4599-B130-FF9D890ECFD4")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsTipWindow = interface
[<System.Runtime.InteropServices.ComConversionLoss>]
[<System.Runtime.InteropServices.Guid("64C7FFC4-B9EE-4599-B130-FF9D890ECFD4")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsTipWindow = interface
Public Interface IVsTipWindow
Derived
Attributes
ComConversionLossAttribute GuidAttribute InterfaceTypeAttribute

Remarks

Implement this interface on your language service object to provide generic 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 tip information to the user.

To provide method tips, your language service must call SetMethodData and implement IVsMethodData.

Notes to Implementers

Implement this interface on your language service object to provide a tip when the mouse pauses over a particular context stream in the core editor.

Methods

Dismiss()

Closes the ToolTip window.
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.
GetSizePreferences(RECT[], TIPSIZEDATA[])

Gets the size preferences for the ToolTip window.
Paint(IntPtr, RECT[])

Paints the ToolTip window.
WndProc(IntPtr, UInt32, IntPtr, IntPtr)

Event handler for the tip window.

Applies to