IVsSmartTagTipWindow.GetSizePreferences Method

Article
03/11/2013

Returns the size preferences for a tip window.

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

Syntax

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

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

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

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

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

Parameters

prcCtxBounds
Type: array<Microsoft.VisualStudio.OLE.Interop.RECT[]
[in] Coordinates of the bounding rectangle.

pSizeData
Type: array<Microsoft.VisualStudio.TextManager.Interop.SMARTTAGSIZEDATA[]
[out] Size of the tip window. For values see SMARTTAGSIZEDATA.

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 textmgr2.idl:

HRESULT IVsSmartTagTipWindow::GetSizePreferences(
   [out] const RECT *prcCtxBounds,
   [out] SMARTTAGSIZEDATA *pSizeData
);

Implementations should be written to handle cases where the size preference they return here are not what they are given for real estate in which to display content. (that is, it may not be possible to provide the tip window in the requested size). The prcCtxBounds parameter represents the bounding rectangle of the tip's context, should the implementation be interested. This rectangle is provided in screen coordinates.

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