IVsSmartTagTipWindow.GetSizePreferences(RECT[], SMARTTAGSIZEDATA[]) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.8.0.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 tip window.

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

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

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

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

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

Parameters

prcCtxBounds: RECT[]

[in] Coordinates of the bounding rectangle.

pSizeData: SMARTTAGSIZEDATA[]

[out] Size of the tip window. For values see SMARTTAGSIZEDATA.

Returns

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 returned here is not the same as the actual real estate available to display content. (that is, cases where 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, for use if needed by the implementation. This rectangle is provided in screen coordinates.

Applies to