Class EPCommandWithDescriptor
The base command for all commands with descriptors in the LemonEdge platform, implementing the IEPCommandWithDescriptor interface
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.UI.API.Commands
Assembly: LemonEdge.Client.UI.API.dll
Syntax
public abstract class EPCommandWithDescriptor : EPCommand, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IDisposable, IEPCommandWithDescriptor, IEPCommand, ICommand, ICommandDescriptorConstructors
EPCommandWithDescriptor(IRootController, IModelLayoutCommon?, EPCommandWithDescriptor?)
Creates a new EPCommand, with the app controller, for when the owner is not available.
Declaration
protected EPCommandWithDescriptor(IRootController rootController, IModelLayoutCommon? owner = null, EPCommandWithDescriptor? parent = null)Parameters
| Type | Name | Description |
|---|---|---|
| IRootController | rootController | The application controller, for service access |
| IModelLayoutCommon | owner | The owning context this command operates within |
| EPCommandWithDescriptor | parent | An optional parent command if this command is a child command |
Properties
Description
A user friendly description of this command
Declaration
public abstract string Description { get; }Property Value
| Type | Description |
|---|---|
| string |
HelpURL
An optional url for help documentation around this commands function
Declaration
public virtual string HelpURL { get; }Property Value
| Type | Description |
|---|---|
| string |
IconID
Declaration
public virtual Guid IconID { get; }Property Value
| Type | Description |
|---|---|
| Guid |
OverlayIconID
On some clients another image can be overlayed on the bottom right of the main icon (for indicating add, remove, etc)
This optional overlay image can be specified here, either a ImageType or ImageID
Declaration
public virtual Guid? OverlayIconID { get; }Property Value
| Type | Description |
|---|---|
| Guid? |
Parameter
Any parameter for this command, deriving from CommandSerializedParam
Declaration
public virtual string Parameter { get; }Property Value
| Type | Description |
|---|---|
| string |
Title
The title of this command
Declaration
public abstract string Title { get; }Property Value
| Type | Description |
|---|---|
| string |
ToolTip
A user friendly tool tip for this command functionality, by default the Description
Declaration
public virtual string ToolTip { get; }Property Value
| Type | Description |
|---|---|
| string |
Type
A globally unique id to identify this command in uniquel in the main menu. Comes from Type if it came from the standard set, but can be any id for custom commands, or Guid.Empty otherwise
Declaration
public virtual Guid Type { get; }Property Value
| Type | Description |
|---|---|
| Guid |