Class ViewCommandWrapper

Inheritance
object
BaseHasChildren<EPCommandWithDescriptor>
EPCommand
EPCommandWithDescriptor
ViewCommand
ViewCommandWrapper
Implements
Inherited Members
Namespace: LemonEdge.Client.UI.API.Views.Commands
Assembly: LemonEdge.Client.UI.API.dll
Syntax
public class ViewCommandWrapper : ViewCommand, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IDisposable, IEPCommandWithDescriptor, IEPCommand, ICommand, ICommandDescriptor

Constructors

ViewCommandWrapper(EPCommand, string, string, Guid)

Declaration
public ViewCommandWrapper(EPCommand original, string title, string tooltip, Guid icon)
Parameters
Type Name Description
EPCommand original
string title
string tooltip
Guid icon

Properties

Children

All Child items in this item. If this has a Order, then this is enumerated according to that order

Declaration
public override IEnumerable<EPCommandWithDescriptor> Children { get; }
Property Value
Type Description
IEnumerable<EPCommandWithDescriptor>
Overrides
LemonEdge.Utils.BaseHasChildren<LemonEdge.Client.UI.API.Commands.EPCommandWithDescriptor>.Children

Description

A user friendly description of this command

Declaration
public override string Description { get; }
Property Value
Type Description
string
Overrides

HasChildCommands

Indicates this command has child commands that should be loaded by the LemonEdge system using LoadChildrenAsync()

The default is false

Declaration
public override bool HasChildCommands { get; }
Property Value
Type Description
bool
Overrides

IconID

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

Declaration
public override Guid IconID { get; }
Property Value
Type Description
Guid
Overrides

SubscribeToLayoutChange

Indicates this command should track changes to the layouts and reevaluate its Can Execute status.

Used by commands such as Save which change their enabled status depending on the currently active layout

Declaration
protected override bool SubscribeToLayoutChange { get; }
Property Value
Type Description
bool
Overrides

Title

The title of this command

Declaration
public override string Title { get; }
Property Value
Type Description
string
Overrides

ToolTip

A user friendly tool tip for this command functionality, by default the Description

Declaration
public override string ToolTip { get; }
Property Value
Type Description
string
Overrides

Methods

InternalCanExecute(object)

Returns if this command can be executed or not from the client application UI

You must override InternalCanExecute(object?) or InternalCanExecuteAsync(object?) in order to implement if it can be executed

Declaration
public override bool InternalCanExecute(object parameter)
Parameters
Type Name Description
object parameter

The command parameter
Returns
Type Description
bool

If this command can be executed or not from the client application UI
Overrides

InternalCanExecuteAsync(object)

Returns if this command can be executed or not from the client application UI

You must override InternalCanExecute(object?) or InternalCanExecuteAsync(object?) in order to implement if it can be executed

Declaration
public override Task<bool> InternalCanExecuteAsync(object parameter)
Parameters
Type Name Description
object parameter

The command parameter
Returns
Type Description
Task<bool>

If this command can be executed or not from the client application UI
Overrides

InternalExecute(object)

You must override InternalExecuteAsync(object) or InternalExecute(object) in order to implement your commands action

Declaration
public override void InternalExecute(object parameter)
Parameters
Type Name Description
object parameter

The command parameter
Overrides

InternalExecuteAsync(object)

You must override InternalExecuteAsync(object) or InternalExecute(object) in order to implement your commands action

Declaration
public override Task InternalExecuteAsync(object parameter)
Parameters
Type Name Description
object parameter

The command parameter
Returns
Type Description
Task
Overrides

LoadChildrenAsync()

Provides an inheriting command the opportunity to load any child commands contained within it

Declaration
public override Task LoadChildrenAsync()
Returns
Type Description
Task
Overrides

Implements

Extension Methods