Class TransactionSettingsEdit
A view command that allows the editing of the settings (ascertained from API.Entities.ITransaction.SettingsTypeID) associated with a transaction
The SettingTypeID entity type id must implement IHasTransactionSetting
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Commands.ViewCommands
Assembly: LemonEdge.ClientCore.dll
Syntax
public class TransactionSettingsEdit : ViewCommand, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IDisposable, IEPCommandWithDescriptor, IEPCommand, ICommand, ICommandDescriptorConstructors
TransactionSettingsEdit(IRootController, IModelLayoutDisplayer, Func<(IEntityUpdaterUI Updater, ITransaction Transaction)>)
Creates a new TransactionSettingsEdit
Declaration
public TransactionSettingsEdit(IRootController root, IModelLayoutDisplayer host, Func<(IEntityUpdaterUI Updater, ITransaction Transaction)> getTransactionInfo)Parameters
| Type | Name | Description |
|---|---|---|
| IRootController | root | The root controller, for service access. |
| IModelLayoutDisplayer | host | The host context this command operates within |
| Func<(IEntityUpdaterUI Updater, ITransaction Transaction)> | getTransactionInfo | A function that returns the info for the transaction to have its settings edited for |
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
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 the transaction to be edited has a API.Entities.ITransaction.SettingsTypeID set (automatically set from SettingsTypeID config) and is not currently cancelled
Declaration
public override Task<bool> InternalCanExecuteAsync(object parameter)Parameters
| Type | Name | Description |
|---|---|---|
| object | parameter | The command parameter |
Returns
| Type | Description |
|---|---|
| Task<bool> | True if the transaction to be edited has a API.Entities.ITransaction.SettingsTypeID set (automatically set from SettingsTypeID config) and is not currently cancelled |
Overrides
InternalExecuteAsync(object)
Gets the transaction to have its settings edited and loads the settings screen for the specified entity API.Entities.ITransaction.SettingsTypeID as a popup window
The SettingTypeID entity type id must implement IHasTransactionSetting
Declaration
public override Task InternalExecuteAsync(object parameter)Parameters
| Type | Name | Description |
|---|---|---|
| object | parameter | The command parameter |
Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operation |