Difference between revisions of "NoHelpMode"
From SAP Enable Now Wiki
(→Usage) |
|||
| Line 6: | Line 6: | ||
==Purpose== | ==Purpose== | ||
| − | + | This parameter determines what is displayed if the user clicks on the '''Help''' button (?) and no help content is available for the current context. Most commonly, this parameter is used with a value of '''<tt>carousel</tt>''' to prevent the "No help available" dialog box from being displayed. | |
==Usage== | ==Usage== | ||
Specified as: | Specified as: | ||
| − | noHelpMode=['''hidebutton'''|carousel]] | + | noHelpMode=['''hidebutton'''|nothing|carousel]] |
| − | + | These values have the following effects: | |
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! Value !! effect | ||
| + | |- | ||
| + | | <tt>hidebutton</tt> || The '''onHelpAvailable''' event is triggered with a value of '''false'''. Typically, this results in the '''Help''' button being hidden. | ||
| + | |- | ||
| + | | <tt>nothing</tt> || The '''Help''' button is highlighted, as normal. | ||
| + | |- | ||
| + | | <tt>carousel</tt> || The ''[[Carousel]]'' is displayed, with either the ''Learning'' page displayed (if configured to display), or an empty ''Help Topics'' page. | ||
| + | |} | ||
[[Category: Web Assistant parameter]] | [[Category: Web Assistant parameter]] | ||
Revision as of 11:00, 31 May 2020
Scope
Web Assistant parameter, specified either in the URL or in the Web Assistant parameters in the linked application.
Purpose
This parameter determines what is displayed if the user clicks on the Help button (?) and no help content is available for the current context. Most commonly, this parameter is used with a value of carousel to prevent the "No help available" dialog box from being displayed.
Usage
Specified as:
noHelpMode=[hidebutton|nothing|carousel]]
These values have the following effects:
| Value | effect |
|---|---|
| hidebutton | The onHelpAvailable event is triggered with a value of false. Typically, this results in the Help button being hidden. |
| nothing | The Help button is highlighted, as normal. |
| carousel | The Carousel is displayed, with either the Learning page displayed (if configured to display), or an empty Help Topics page. |
