Platform SDK: Agent

Active Property

Description
Returns whether your application is the active client of the character and whether the character is topmost.
Syntax
agent.Characters ("CharacterID").Active [ = State]
Part Description
state An integer expression specifying the state of your client application.

0 Not the active client.

1 The active client.

2 The input-active client. (The topmost 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.

You can use the Activate method to set whether your application is the active client of the character or to make your application the input active client (which also makes the character topmost).

See Also

Activate method