Class CustomViewCommand
A command that executes a custom command for a view
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Commands.ViewCommands
Assembly: LemonEdge.ClientCore.dll
Syntax
public class CustomViewCommand : ViewCommand, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IDisposable, IEPCommandWithDescriptor, IEPCommand, ICommand, ICommandDescriptorConstructors
CustomViewCommand(IRootController, IModelLayoutDisplayer, IModelView, ICustomCommand, Func<object, Task>)
Declaration
public CustomViewCommand(IRootController root, IModelLayoutDisplayer owner, IModelView view, ICustomCommand cmd, Func<object, Task> processResult)Parameters
| Type | Name | Description |
|---|---|---|
| IRootController | root | |
| IModelLayoutDisplayer | owner | |
| IModelView | view | |
| ICustomCommand | cmd | |
| Func<object, Task> | processResult |
Properties
Description
A user friendly description of this command
Declaration
public override string Description { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
HelpURL
An optional url for help documentation around this commands function
Declaration
public override string HelpURL { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
IconID
Declaration
public override Guid IconID { get; }Property Value
| Type | Description |
|---|---|
| Guid |
Overrides
IncludeInSimple
By default view commands are included in any simple layout filtering of commands if they are part of the quick access
Declaration
public override bool IncludeInSimple { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
IsQuickAccessCommand
Indicates this command should also be available in a quick access manner if the ui permits it to be highlighted and seperated for quick access among a group of other commands
For instance in the desktop application view commands are accessible from a drop down menu by default, but if this is true they are also directly accessible from the view itself
Declaration
public override bool IsQuickAccessCommand { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
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 override Guid? OverlayIconID { get; }Property Value
| Type | Description |
|---|---|
| Guid? |
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
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
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 |