Class Help
This command executes the Help system command
Loads child commands containing context sensitive help on the system, menu items, role, and active views within the active layout
Users can customise the help using the ItemHelpURL, ContextHelpURL, LayoutHelpURL, or RoleHelpURLImplements
Inherited Members
Namespace: LemonEdge.Client.Core.Commands
Assembly: LemonEdge.ClientCore.dll
Syntax
[CommandDescriptorOptions(Command.Help, null)]
public class Help : EPCommandWithDescriptor, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IDisposable, IEPCommandWithDescriptor, IEPCommand, ICommand, ICommandDescriptorConstructors
Help(IRootController, IModelLayoutCommon)
Creates a new Help command
Declaration
public Help(IRootController root, IModelLayoutCommon owner)Parameters
| Type | Name | Description |
|---|---|---|
| IRootController | root | The root controller, for service access. |
| IModelLayoutCommon | owner | The owning context for this command |
Fields
BASE_URL
Declaration
public const string BASE_URL = "https://help.lemonedge.com/"Field Value
| Type | Description |
|---|---|
| string |
Properties
Description
A user friendly description of this command
Declaration
public override string Description { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
HasChildCommands
True - has all the context sensistive help as sub commands
Declaration
public override bool HasChildCommands { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
IconID
The default Question system image
Declaration
public override Guid IconID { get; }Property Value
| Type | Description |
|---|---|
| Guid |
Overrides
Title
Help
Declaration
public override string Title { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
Methods
InternalCanExecute(object)
True - can always access help
Declaration
public override bool InternalCanExecute(object parameter)Parameters
| Type | Name | Description |
|---|---|---|
| object | parameter | The command parameter |
Returns
| Type | Description |
|---|---|
| bool | True |
Overrides
InternalExecute(object)
Loads the child commands into view
Declaration
public override void InternalExecute(object parameter)Parameters
| Type | Name | Description |
|---|---|---|
| object | parameter | The command parameter |
Overrides
LoadChildrenAsync()
Loads the child system, menu item, role, and active view help commands depending on the current context
Declaration
public override Task LoadChildrenAsync()Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operation |