ITfLangBarItemBalloon::GetPreferredSize method (ctfutb.h)

Article
11/19/2022

Obtains the preferred size,in pixels, of the balloon.

Syntax

HRESULT GetPreferredSize(
  [in]  const SIZE *pszDefault,
  [out] SIZE       *psz
);

Parameters

[in] pszDefault

Pointer to a SIZE structure that contains the default size, in pixels, of the balloon.

[out] psz

Pointer to a SIZE structure that receives the preferred balloon size, in pixels. The cy member of this structure is ignored.

Return value

This method can return one of these values.

Value	Description
S_OK	The method was successful.

Remarks

This method is required. The balloon must supply the preferred size in response to this method.

To obtain the font used to draw the balloon, call GetStockObject with DEFAULT_GUI_FONT. This font can be used to calculate the preferred balloon size at runtime.

If the balloon text will not fit into the preferred size obtained from this method, the language bar truncates the text and adds an ellipses to the text.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	ctfutb.h
DLL	Msctf.dll
Redistributable	TSF 1.0 on Windows 2000 Professional