IVsTipWindow.GetSizePreferences(RECT[], TIPSIZEDATA[]) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Gets the size preferences for the ToolTip window.

public:
 int GetSizePreferences(cli::array <Microsoft::VisualStudio::OLE::Interop::RECT> ^ prcCtxBounds, cli::array <Microsoft::VisualStudio::TextManager::Interop::TIPSIZEDATA> ^ pSizeData);

int GetSizePreferences(std::Array <Microsoft::VisualStudio::OLE::Interop::RECT> const & prcCtxBounds, std::Array <Microsoft::VisualStudio::TextManager::Interop::TIPSIZEDATA> const & pSizeData);

public int GetSizePreferences (Microsoft.VisualStudio.OLE.Interop.RECT[] prcCtxBounds, Microsoft.VisualStudio.TextManager.Interop.TIPSIZEDATA[] pSizeData);

abstract member GetSizePreferences : Microsoft.VisualStudio.OLE.Interop.RECT[] * Microsoft.VisualStudio.TextManager.Interop.TIPSIZEDATA[] -> int

Public Function GetSizePreferences (prcCtxBounds As RECT(), pSizeData As TIPSIZEDATA()) As Integer

Parameters

prcCtxBounds: RECT[]

[out] The bounding rectangle of the ToolTip window, in screen coordinates.

pSizeData: TIPSIZEDATA[]

[out] Size and position of the ToolTip window. For a list of pSizeData values, see TIPSIZEDATA.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsTipWindow::GetSizePreferences(  
   [out] const RECT *prcCtxBounds,  
   [out] TIPSIZEDATA *pSizeData  
);

Implement this method to handle instances where the size preferences do not match the area available to display the ToolTip window. That is, it may not be possible to provide a ToolTip window of the requested size.

Applies to