IVsTipWindow.GetSizePreferences Method

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

'宣言
Function GetSizePreferences ( _
    <OutAttribute> prcCtxBounds As RECT(), _
    <OutAttribute> pSizeData As TIPSIZEDATA() _
) As Integer
'使用
Dim instance As IVsTipWindow
Dim prcCtxBounds As RECT()
Dim pSizeData As TIPSIZEDATA()
Dim returnValue As Integer

returnValue = instance.GetSizePreferences(prcCtxBounds, _
    pSizeData)
int GetSizePreferences(
    RECT[] prcCtxBounds,
    TIPSIZEDATA[] pSizeData
)
int GetSizePreferences(
    [OutAttribute] array<RECT>^ prcCtxBounds, 
    [OutAttribute] array<TIPSIZEDATA>^ pSizeData
)
function GetSizePreferences(
    prcCtxBounds : RECT[], 
    pSizeData : TIPSIZEDATA[]
) : int

Parameters

  • prcCtxBounds
    Type: []

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

  • pSizeData
    Type: []

    [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.

Permissions

See Also

Reference

IVsTipWindow Interface

IVsTipWindow Members

Microsoft.VisualStudio.TextManager.Interop Namespace