Class MoveItemUp<T>
A view command that moves the selected items up (decrementing their index) within a collection of items
Works against entities with a sequence property marked with the EntitySequenceAttribute
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Commands.ViewCommands
Assembly: LemonEdge.ClientCore.dll
Syntax
public class MoveItemUp<T> : ViewCommand, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IDisposable, IEPCommandWithDescriptor, IEPCommand, ICommand, ICommandDescriptor
Type Parameters
Name | Description |
---|---|
T | The type of entity this command works against |
Constructors
MoveItemUp(IRootController, IModelLayoutDisplayer, BaseGridControllerAny<T>)
Creates a new MoveItemUp command
Declaration
public MoveItemUp(IRootController root, IModelLayoutDisplayer owner, BaseGridControllerAny<T> controller)
Parameters
Type | Name | Description |
---|---|---|
IRootController | root | The root controller, for service access. |
IModelLayoutDisplayer | owner | The owning host context for this command |
BaseGridControllerAny<T> | controller | The gridcontroller this command works against to move the selected items up within |
Properties
Description
A user friendly description of this command
Declaration
public override string Description { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
IconID
Declaration
public override Guid IconID { get; }
Property Value
Type | Description |
---|---|
Guid |
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 true if there are selected items in the grid and they are not the first item in the grid (as they can not be moved up anymore)
Declaration
public override Task<bool> InternalCanExecuteAsync(object parameter)
Parameters
Type | Name | Description |
---|---|---|
object | parameter |
Returns
Type | Description |
---|---|
Task<bool> | True if there are selected items in the grid and they are not the first item in the grid (as they can not be moved up anymore) |
Overrides
InternalExecuteAsync(object)
Retrieves all the items selected to move up, then decrements their sequence number, and increments all those items below them. Updates the grid display to show the items having moved up.
Declaration
public override Task InternalExecuteAsync(object parameter)
Parameters
Type | Name | Description |
---|---|---|
object | parameter | The command parameters |
Returns
Type | Description |
---|---|
Task | A task indicating the completion of the operation |
Overrides
MoveItemToItem(T, T)
Declaration
public void MoveItemToItem(T item, T toItem)
Parameters
Type | Name | Description |
---|---|---|
T | item | |
T | toItem |