IVsTipWindow.GetSizePreferences Method

Article
2013-03-11

Gets the size preferences for the ToolTip window.

Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

'Declaration
Function GetSizePreferences ( _
    <OutAttribute> prcCtxBounds As RECT(), _
    <OutAttribute> pSizeData As TIPSIZEDATA() _
) As Integer

int GetSizePreferences(
    RECT[] prcCtxBounds,
    TIPSIZEDATA[] pSizeData
)

int GetSizePreferences(
    [OutAttribute] array<RECT>^ prcCtxBounds, 
    [OutAttribute] array<TIPSIZEDATA>^ pSizeData
)

abstract GetSizePreferences : 
        prcCtxBounds:RECT[] byref * 
        pSizeData:TIPSIZEDATA[] byref -> int

function GetSizePreferences(
    prcCtxBounds : RECT[], 
    pSizeData : TIPSIZEDATA[]
) : int

Parameters

prcCtxBounds
Type: array<Microsoft.VisualStudio.OLE.Interop.RECT[]
[out] The bounding rectangle of the ToolTip window, in screen coordinates.

pSizeData
Type: array<Microsoft.VisualStudio.TextManager.Interop.TIPSIZEDATA[]
[out] Size and position of the ToolTip window. For a list of pSizeData values, see TIPSIZEDATA.

Return Value

Type: System.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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via