ShellHelpPanel
Defined in: js-api/src/shell.ts:446
Represents help panel that shows help for the current object and is toggleable by pressing F1
Constructors
Constructor
new ShellHelpPanel():
ShellHelpPanel
Returns
ShellHelpPanel
Accessors
syncCurrentObject
Get Signature
get syncCurrentObject():
boolean
Defined in: js-api/src/shell.ts:448
Controls whether the help panel shows help for the current object as it changes
Returns
boolean
Set Signature
set syncCurrentObject(
x):void
Defined in: js-api/src/shell.ts:449
Parameters
| Parameter | Type |
|---|---|
x | boolean |
Returns
void
visible
Get Signature
get visible():
boolean
Defined in: js-api/src/shell.ts:452
Controls help panel visibility
Returns
boolean
Set Signature
set visible(
x):void
Defined in: js-api/src/shell.ts:453
Parameters
| Parameter | Type |
|---|---|
x | boolean |
Returns
void
Methods
showHelp()
showHelp(
x):void
Defined in: js-api/src/shell.ts:456
Shows the content in the help window for the [x] URL or object.
Parameters
| Parameter | Type |
|---|---|
x | any |
Returns
void