Class EPCommandWithDescriptor

The base command for all commands with descriptors in the LemonEdge platform, implementing the IEPCommandWithDescriptor interface

Inheritance
System.Object
BaseHasChildren<EPCommandWithDescriptor>
EPCommand
EPCommandWithDescriptor
Help
LoadFavourite
SwitchCanvas
SwitchRole
SwitchTeam
SwitchTheme
ViewCommand
CancelTask
Implements
System.IDisposable
System.Windows.Input.ICommand
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: LemonEdge.Client.Core.Commands
Assembly: ClientCore.dll
Syntax
public abstract class EPCommandWithDescriptor : EPCommand, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IDisposable, IEPCommandWithDescriptor, IEPCommand, ICommand, ICommandDescriptor

Constructors

EPCommandWithDescriptor(IModelLayoutCommon, EPCommandWithDescriptor)

Creates a new EPCommandWithDescriptor

Declaration
public EPCommandWithDescriptor(IModelLayoutCommon owner, EPCommandWithDescriptor parent = null)
Parameters
Type Name Description
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
System.String

HelpURL

An optional url for help documentation around this commands function

Declaration
public virtual string HelpURL { get; }
Property Value
Type Description
System.String

IconID

The image to use for this command, either a ImageType or ImageID

Declaration
public virtual Guid IconID { get; }
Property Value
Type Description
System.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
System.Nullable<System.Guid>

Parameter

Any parameter for this command, deriving from CommandSerializedParam

Declaration
public virtual string Parameter { get; }
Property Value
Type Description
System.String

Title

The title of this command

Declaration
public abstract string Title { get; }
Property Value
Type Description
System.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
System.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
System.Guid

Explicit Interface Implementations

ICommandDescriptor.Title

The title of this command

Declaration
string ICommandDescriptor.Title { get; set; }
Returns
Type Description
System.String

Implements

System.IDisposable
System.Windows.Input.ICommand

Extension Methods