Invokes specific electronic documentation within the current workspace.
Syntax |
invokeHelp(string bookName, int mode=helpDefault, params=""): bool |
|---|---|
bookName |
Name of the desired book |
mode |
Book activation mode (#1) |
params |
Any parameters for the indicated mode (optional, default "") |
Result |
Returns logical outcome of operation |
The modes (#1) valid for book activation, are as follows:
Mode |
Description |
|---|---|
helpDefault |
Default mode (decides RDE3) |
helpContent |
Open on main page |
helpIndex |
Open on main page, with index panel enabled |
helpTopic |
Open on the topic specified in the parameters |
helpSearch |
Open on the main page, with search panel activated |
