readme.htm

Office 97 中『小帮手』

<tr><a name="BringToFront"></a>
<td bgcolor="#FFEE00"><small>
<b>procedure BringToFront;</b><br>
Assistant normally will not place on top of modal forms. When a modal form is showing,
<b>BringToFront</b> brings the assistant on top of the modal form.
</small></td>
</tr>
<tr><a name="CloseBalloon"></a>
<td bgcolor="#F0E000"><small>
<b>procedure CloseBalloon;</b><br>
Closes the current visible balloon.
</small></td>
</tr>
<tr>
<td bgcolor="#FFEE00"><small>
<b>constructor Create(AOwner: TComponent);</b><br>
Creates and initializes a new TAssistant.
</small></td>
</tr>
<tr>
<td bgcolor="#F0E000"><small>
<b>destructor Destroy; </b><br>
Destroys an instance of TAssistant.
</small></td>
</tr>
<tr>
<td bgcolor="#FFEE00"><small>
<b>function GestureAt(X, Y: Integer): <a href="#TRequestID">TRequestID</a>;</b><br>
Plays the gesture animation according to the screen coordinate specified by X and Y parameters.
The function returns a unique id for played animation or zero on error.
</small></td>
</tr>
<tr>
<td bgcolor="#F0E000"><small>
<b>function GlanceAt(X, Y: Integer): <a href="#TRequestID">TRequestID</a>;</b><br>
Plays the glance animation according to the screen coordinate specified by X and Y parameters.
The function returns a unique id for played animation or zero on error.
</small></td>
</tr>
<tr>
<td bgcolor="#FFEE00"><small>
<b>procedure Hide(Fast: Boolean);</b><br>
Hides the assistant. If Fast is true, the hide animation will not play.
</small></td>
</tr>
<tr>
<td bgcolor="#F0E000"><small>
<b>function IsValid(RequestID: <a href="#TRequestID">TRequestID</a>): Boolean;</b><br>
If the specified RequestID is a playing or queued animation, the function returns true.
</small></td>
</tr>
<tr>
<td bgcolor="#FFEE00"><small>
<b>function LookAt(X, Y: Integer): <a href="#TRequestID">TRequestID</a>;</b><br>
Plays the look animation according to the screen coordinate specified by X and Y parameters.
The function returns a unique id for played animation or zero on error.
</small></td>
</tr>
<tr><a name="MessageDlg"></a>
<td bgcolor="#F0E000"><small>
<b>function MessageDlg(const Msg: String; AType: TMsgDlgType; AButtons: TMsgDlgButtons; HelpCtx: LongInt): Word;</b><br>
This function is as same as Delphi MessageDlg function except that this method shows a balloon.
</small></td>
</tr>
<tr><a name="MoveTo"></a>
<td bgcolor="#FFEE00"><small>
<b>procedure MoveTo(X, Y: Integer);</b><br>
Plays the move animation according to the screen coordinate specified by X and Y parameters and
move the assistant to this screen coordinate.
</small></td>
</tr>
<tr>
<td bgcolor="#F0E000"><small>
<a name="PlayIndex"></a>
<Font Color="#008888">Delphi 4.0, 5.0:</Font><br>
<b>function Play(Index: Word): <a href="#TRequestID">TRequestID</a>;</b><br>
<Font Color="#008888">Delphi 3.0:</Font><br>
<b>function PlayIndex(Index: Word): <a href="#TRequestID">TRequestID</a>;</b><br>
Plays the animation specified by the animation's index.
The function returns a unique id for played animation or zero on error.
</small></td>
</tr>
<tr>
<td bgcolor="#FFEE00"><small>
<Font Color="#008888">Delphi 3.0, 4.0, 5.0:</Font><br>
<b>function Play(Name: String): <a href="#TRequestID">TRequestID</a>;</b><br>
<Font Color="#008888">Delphi 3.0:</Font><br>
<b>function PlayName(Name: String): <a href="#TRequestID">TRequestID</a>;</b><br>
Plays the animation specified by the animation's name.
The function returns a unique id for played animation or zero on error.
</small></td>
</tr>
<tr>
<td bgcolor="#F0E000"><small>
<Font Color="#008888">Delphi 3.0, 4.0, 5.0:</Font><br>
<b>function Play(Action: <a href="#TActorAction">TActorAction</a>): <a href="#TRequestID">TRequestID</a>;</b><br>
<Font Color="#008888">Delphi 3.0:</Font><br>
<b>function PlayAction(Action: <a href="#TActorAction">TActorAction</a>): <a href="#TRequestID">TRequestID</a>;</b><br>
Plays randomly one of animations associated to the action.
The function returns a unique id for played animation or zero on error.
</small></td>
</tr>
<tr>
<td bgcolor="#FFEE00"><small>
<b>procedure Show(Fast: Boolean);</b><br>
Shows the assistant. If Fast is true, the show animation will not play.
</small></td>
</tr>
<tr><a name="ShowGuide"></a>
<td bgcolor="#F0E000"><small>
<b>procedure ShowGuide;</b><br>
Shows the Guide balloon.
</small></td>
</tr>
<tr><a name="ShowTips"></a>
<td bgcolor="#FFEE00"><small>
<b>procedure ShowTips;</b><br>
Shows the Tips balloon.
</small></td>
</tr>
<tr><a name="Speak"></a>
<td bgcolor="#F0E000"><small>
<b>procedure Speak(const Msg: String; Timeout: Integer = 0);</b><br>
Shows a balloon containing the Msg and wait for timeout to hide the balloon. The timeout
is in milliseconds and if it is zero the balloon will be hide only by calling the
<a href="#CloseBalloon">CloseBalloon</a> method.
</small></td>
</tr>
<tr>
<td bgcolor="#FFEE00"><small>
<b>procedure Stop(RequestID: <a href="#TRequestID">TRequestID</a>);</b><br>
Stops the specified animation if it is playing or removes it from queue if it is
queued.
</small></td>
</tr>
<tr>
<td bgcolor="#F0E000"><small>
<b>procedure StopAll;</b><br>
Stops the current playing animation and empties the animation queue.
</small></td>
</tr>
<tr><a name="Think"></a>
<td bgcolor="#FFEE00"><small>
<b>procedure Think(const Msg: String; Timeout: Integer = 0);</b><br>
Shows a think balloon containing the Msg and wait for timeout to hide the balloon.
The timeout is in milliseconds and if it is zero the balloon will be hide only by calling
the <a href="#CloseBalloon">CloseBalloon</a> method.
</small></td>
</tr>
<tr>
<td bgcolor="#F0E000"><small>
<b>function WaitFor(RequestID: <a href="#TRequestID">TRequestID</a>): Boolean;</b><br>
Waits for specified animation until its playing terminate. If the specified animation
has an infinite loop, the function returns immediately with a false result.
</small></td>
</tr>
</table>

<br>

<table border="0" cellpadding="2" cellspacing="2" width="100%">
<caption><a name="TAssistant-Events"><b>TAssistant Events</b></a></caption>
<tr>
<td width="25%" bgcolor="#506000"><b><font color="#ffffff"><small>Event Name</small></font></b></td>
<td width="20%" bgcolor="#506000"><b><font color="#ffffff"><small>Type</small></font></b></td>
<td bgcolor="#506000"><b><font color="#ffffff"><small>Description</small></font></b></td>
</tr>
<tr>
<td bgcolor="#F0E000"><small><b>OnBalloonHide</b></small></td>
<td bgcolor="#F0E000"><small><b>TNotifyEvent</b></small></td>
<td bgcolor="#F0E000"><small>Occurs when the balloon hides.</small></td>
</tr>
<tr>
<td bgcolor="#FFEE00"><small><b>OnBalloonShow</b></small></td>
<td bgcolor="#FFEE00"><small><b>TNotifyEvent</b></small></td>
<td bgcolor="#FFEE00"><small>Occurs when the balloon shows.</small></td>
</tr>
<tr>
<td bgcolor="#F0E000"><small><b>OnCanResize</b></small></td>
<td bgcolor="#F0E000"><small><b>TCanResizeEvent</b></small></td>
<td bgcolor="#F0E000"><small>Occurs when an attempt is made to resize the assistant window.</small></td>
</tr>
<tr>
<td bgcolor="#FFEE00"><small><b>OnChange</b></small></td>
<td bgcolor="#FFEE00"><small><b>TNotifyEvent</b></small></td>
<td bgcolor="#FFEE00"><small>Occurs whenever the
<a href="#ActorLibrary-a">ActorLibrary</a> changes.</small></td>
</tr>
<tr>
<td bgcolor="#F0E000"><small><b>OnClick</b></small></td>
<td bgcolor="#F0E000"><small><b>TNotifyEvent</b></small></td>
<td bgcolor="#F0E000"><small>Occurs when the user clicks on the assistant.</small></td>
</tr>
<tr>
<td bgcolor="#FFEE00"><small><b>OnCloseQuery</b></small></td>
<td bgcolor="#FFEE00"><small><b>TCloseQueryEvent</b></small></td>
<td bgcolor="#FFEE00"><small>Occurs when the user closes the assistant window from the system menu of the window.</small></td>
</tr>
<tr>
<td bgcolor="#F0E000"><small><b>OnDblClick</b></small></td>
<td bgcolor="#F0E000"><small><b>TNotifyEvent</b></small></td>
<td bgcolor="#F0E000"><small>Occurs when the user double-clicks on the assistant.</small></td>
</tr>
<tr>
<td bgcolor="#FFEE00"><small><b>OnDragging</b></small></td>
<td bgcolor="#FFEE00"><small><b>TNotifyEvent</b></small></td>
<td bgcolor="#FFEE00"><small>Occurs when the user is dragging the assistant.</small></td>
</tr>
<tr>
<td bgcolor="#F0E000"><small><b>OnDragStart</b></small></td>
<td bgcolor="#F0E000"><small><b>TNotifyEvent</b></small></td>
<td bgcolor="#F0E000"><small>Occurs when the user begins to drag the assistant.</small></td>
</tr>
<tr>
<td bgcolor="#FFEE00"><small><b>OnDragStop</b></small></td>
<td bgcolor="#FFEE00"><small><b>TNotifyEvent</b></small></td>
<td bgcolor="#FFEE00"><small>Occurs when the dragging of the assistant ends.</small></td>
</tr>
<tr>
<td bgcolor="#F0E000"><small><b>OnGuideOptionsClick</b></small></td>
<td bgcolor="#F0E000"><small><b>TNotifyEvent</b></small></td>
<td bgcolor="#F0E000"><small>Occurs when the user clicks on the options button of the Guide balloon.</small></td>
</tr>
<tr>
<td bgcolor="#FFEE00"><small><b>OnGuideRequestChange</b></small></td>
<td bgcolor="#FFEE00"><small><b>TNotifyEvent</b></small></td>
<td bgcolor="#FFEE00"><small>Occurs when the user changes the text of the edit box on the Guide balloon.</small></td>
</tr>
<tr>
<td bgcolor="#F0E000"><small><b>OnGuideSearchClick</b></small></td>
<td bgcolor="#F0E000"><small><b>TNotifyEvent</b></small></td>
<td bgcolor="#F0E000"><small>Occurs when the user clicks on the search button of the Guide balloon.</small></td>
</tr>
<tr><a name="OnGuideTopicClick"></a>
<td bgcolor="#FFEE00"><small><b>OnGuideTopicClick</b></small></td>
<td bgcolor="#FFEE00"><small><b><a href="#TTopicClickEvent">TTopicClickEvent</a></b></small></td>
<td bgcolor="#FFEE00"><small>Occurs when the user clicks on the one of topics displayed on the Guide balloon.</small></td>
</tr>
<tr>
<td bgcolor="#F0E000"><small><b>OnHide</b></small></td>
<td bgcolor="#F0E000"><small><b>TNotifyEvent</b></small></td>
<td bgcolor="#F0E000"><small>This event just triggered when the assistant goes to hide.</small></td>
</tr>
<tr><a name="#OnHintBulbClick"></a>
<td bgcolor="#FFEE00"><small><b>OnHintBlubClick</b></small></td>
<td bgcolor="#FFEE00"><small><b>TNotifyEvent</b></small></td>
<td bgcolor="#FFEE00"><small>Occurs when the user clicks on the hint bulb.</small></td>
</tr>
</tr>
<tr><a name="#OnHintTopicClick"></a>
<td bgcolor="#F0E000"><small><b>OnHintTopicClick</b></small></td>
<td bgcolor="#F0E000"><small><b><a href="#TTopicClickEvent">TTopicClickEvent</a></b></small></td>
<td bgcolor="#F0E000"><small>Occurs when the user clicks on the one of topics displayed on the Hint balloon.</small></td>
</tr>
<tr><a name="OnIdle"></a>
<td bgcolor="#FFEE00"><small><b>OnIdle</b></small></td>
<td bgcolor="#FFEE00"><small><b><a href="#TIdleEvent">TIdleEvent</a></b></small></td>
<td bgcolor="#FFEE00"><small>This event triggered when the assistant needs to play an idle animation.</small></td>
</tr>
<tr><a name="OnPlayStart"></a>
<td bgcolor="#F0E000"><small><b>OnPlayStart</b></small></td>
<td bgcolor="#F0E000"><small><b><a href="#TPlayEvent">TPlayEvent</a></b></small></td>
<td bgcolor="#F0E000"><small>This event just triggered when an animation begins to play.</small></td>
</tr>
<tr><a name="OnPlayStop"></a>
<td bgcolor="#FFEE00"><small><b>OnPlayStop</b></small></td>
<td bgcolor="#FFEE00"><small><b><a href="#TPlayEvent">TPlayEvent</a></b></small></td>
<td bgcolor="#FFEE00"><small>This event triggered when an animation terminates.</small></td>
</tr>