Properties Required for Task Assistant

By default, hiHelp() opens the Doc Assistant interface. If the help content for a form, dialog, window, or menu is required to be displayed in the Task Assistant interface, you can set some additional properties to open Task Assistant.

The following table describes the properties required for Task Assistant:

Property	Purpose
hiHelpAsstTool	A string value specifying the name of the .tgf file that contains a mapping between help symbols and help documents for the Task Assistant
hiHelpAsstTag	A string value specifying the help symbol to be searched in the .tgf file
hiHelpAsstContext	A string value specifying the current context of the tool. This helps in establishing context-sensitivity while calling help. This is an optional property. Use it to provide a unique help symbol for the currently active tab on a form or docked window, or the active section or element in the user interface.
hiHelpAsstTitle	A string value specifying a title for Task Assistant This is an optional property. If not specified, hiHelp() takes the title from the form, dialog box, or docked window, and adds the Help Assistant suffix to it.
hiHelpAsstPosition	A list with X and Y coordinates of the top left corner of Task Assistant This is an optional property. By default, Task Assistant is placed at X=100 and Y=300.

If both hiHelpAsstTool and hiHelpAsstTag are specified, hiHelp() looks for the help symbol in the .tgf file specified by hiHelpAsstTool. If these properties are not set, their values are incorrect, or no.tgf file is found with the name mentioned by hiHelpAsstTool, hiHelp() switches to the default help search mechanism by using the hiHelpSymName and hiHelpAppName properties.

The following example shows how to specify the properties for a form:

putprop(’formSymbol "myTAHelp" ’hiHelpAsstTool)

putprop(’formSymbol "createPorts" ’hiHelpAsstTag)

putprop(’formSymbol "Fault Analysis Task Assistant" ’hiHelpAsstTitle)

The following example shows how to specify a help symbol for a window and set the properties required to open Task Assistant:

hiOpenWindow( ?appType "MyApp" ?help "MyAppHelp")

putprop( ’MyAppHelp "myTAHelp" ’hiHelpAsstTool)

putprop( ’MyAppHelp "MyHelpSymbol" ’hiHelpAsstTag)

Related Topics

Form and Dialog Box Help

Return to top