ActiveClientChange Event

[Microsoft Agent is deprecated as of Windows 7, and may be unavailable in subsequent versions of Windows.]

Description

Occurs when the active client of the character changes.

Syntax

Sub *agent.*ActiveClientChange (ByVal CharacterID, ByVal Active )

Part	Description
CharacterID	Returns the ID of the character for which the event occurred.
Active	A Boolean value that indicates whether the client became active or not active. True The client application became the active client of the character. False The client application is no longer the active client of the character.

Remarks

When multiple client applications share the same character, the active client of the character receives mouse input (for example, Microsoft Agent control click or drag events). Similarly, when multiple characters are displayed, the active client of the topmost character (also known as the input-active client) receives Command events.

When the active client of a character changes, this event passes back the ID of that character and True if your application has become the active client of the character or False if it is no longer the active client of the character.

A client application may receive this event when the user selects a client application's entry in character's pop-up menu or by voice command, when the client application changes its active status, or when another client application quits its connection to Agent. Agent sends this event only to the client applications that are directly affected; that either become the active client or stop being the active client.

See Also

ActivateInput event, Active property, DeactivateInput event, Activate method