Edit

Share via

HelpFile Property

  • Article

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

Description

Returns or sets the path and filename for a Microsoft Windows context-sensitive Help file supplied by the client application.

Syntax

*agent.*Characters("CharacterID").Helpfile [ = Filename]

Part Description
Filename A string expression specifying the path and filename of the Windows Help file.

 

Remarks

If you've created a Windows Help file for your application and set the character's HelpFile property, Agent automatically calls Help when HelpModeOn is set to True and the user clicks the character or selects a command from its pop-up menu. If you specified a context number in the HelpContextID property of the selected command, Help displays a topic corresponding to the current Help context; otherwise it displays "No Help topic associated with this item."

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.

See Also

HelpModeOn property, HelpContextID property