IAgentBalloonEx::GetStyle

HRESULT GetStyle(
   long * plStyle,  // address of style settings
);

Retrieves the character's word balloon style settings.

• Returns S_OK to indicate the operation was successful.

plStyle

Style settings for the word balloon, which can be a combination of any of the following values:

Value	Description
const unsigned short BALLOON_STYLE_BALLOONON = 0x00000001;	The balloon is supported for output.
const unsigned short BALLOON_STYLE _SIZETOTEXT = 0x0000002;	The balloon height is sized to accommodate the text output.
const unsigned short BALLOON_STYLE _AUTOHIDE = 0x00000004;	The balloon is automatically hidden.
const unsigned short BALLOON_STYLE _AUTOPACE = 0x00000008;	The text output is paced based on the output rate.

When the BalloonOn style bit is set, the word balloon appears when the Speak or Think method is used, unless the user overrides its display through the Microsoft Agent property sheet. When not set, no balloon appears.

When the SizeToText style bit is set, the word balloon automatically sizes the height of the balloon to the current size of the text specified in the Speak or Think method. When not set, the balloon's height is based on the balloon's number of lines property setting. This style bit is set to 1 and an attempt to use IAgentBalloonEx::SetNumLines will result in an error.

When the AutoHide style bit is set, the word balloon automatically hides after a short time-out. When not set, the balloon displays until a new Speak or Think call, the character is hidden, or the user clicks or drags the character.

When the AutoPace style bit is set, the word balloon paces the output based on the current output rate, for example, one word at a time. When output exceeds the size of the balloon, the former text is automatically scrolled. When not set, all text included in a Speak or Think statement displays at once.

This property applies only to your client application's use of the character; the setting does not affect other clients of the character or other characters of your client application.

The defaults for these style bits are based on the settings when the character is compiled through the Microsoft Agent Character Editor.

See Also

IAgentBalloonEx::SetStyle