Namespace LemonEdge.Client.Core.Commands.ViewCommands

Classes

AlterFileProperty

A view command that opens a file and returns the selected file as a byte array. For example:

byte[] myFile = null;
var cmd = new AlterFileProperty(View.Displayer, 
    (dll) => myFile = dll, 
    () => true,
    new LemonEdge.Core.Client.CommandDecriptor("Change Dll", Images.ImageType.AddIn, "Select a new dll for this add-in."),
    new (string, string)[] { (".net Dlls", "*.dll"), ("All Files", "*.*") });

AlterTextProperty

A view command that allows the user to alter a specifc text value in a multi-line popup text editor with optional formatting. For example:

string myText = "HellowWorld!";
var alter = new AlterTextProperty(View.Displayer, 
    () => true,
    () => myText,
    newValue => myText = newValue,
    new LemonEdge.Core.Client.CommandDecriptor("Hello", Images.ImageType.LockKey, "Alter the value"),
    Support.TextType.NormalText, null);

CancelTransaction

A view command that cancels the active IHeaderTransactionalEntity, or all selected ones in a grid

ClearSearchSortFilter

Clears any Search, Sort, and Filtering from a Grid.

Copier

CopyGridItem<T>

A view command for copying selected items of type T in the collection view

Provides multiple mechanisms for overriding this behaviour allowing complete customization on how to create the copied items

If the T implements ISetCopier then that is used to perform a deep clone of the selected items

CopyItemDescriptor<T>

The default implementation of ICopyItemHelper<T> for copying new items in grids

CreateGroupedTransactions

CustomViewCommand

A command that executes a custom command for a view

DeleteGridItem<T>

A view command that prompts a confirmation to the user then deletes the selected items in a grid from the current IEntityUpdater context and removes them from the grid

The pending change can be committed by the user executing the Save command

ExportDefinition

A view command that exports any ISetCopier implemented entities into an xml format describing all their data and related entity structures

This is used for exporting system configuration of top level entities such as IDataset, and any custom entities implementing ISetCopier

FinaliseTransactionsViewCommand

A view command that will create a task to finalize transactions for a given entity and up to the given date

GetUniqueID

A view command that opens a prompt for viewing and editing a Guid value, as a string. For example:

Guid myNewID = Guid.Empty;
var updateID = new GetUniqueID(View.Displayer,
    () => myNewID,
    (newID) => myNewID = newID,
    () => CurrentDisplayedItem != null,
    new LemonEdge.Core.Client.CommandDecriptor("Update ID", ImageType.UniqueID, "Update image unique reference ID.", ImageType.Image));

GridColumnsVisible

A custom view command of type ColumnSelector

IsPublic

A toggle view command that toggles the specified item between being public and private to the logged in user

Lockable

A view command that can toggle a view between being locked and unlocked for editing. The controller must implement ILockableController

Toggling this will unlock/lock all views that implement ILockableController

MoveItemDown<T>

A view command that moves the selected items down (incrementing their index) within a collection of items

Works against entities with a sequence property marked with the EntitySequenceAttribute

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

NewGridItem<T>

A view command that creates a new item of entity type T in a view grid

Provides multiple mechanisms for overriding this behaviour allowing complete customization on how to create the new item

NewItemDescriptor<T>

A default implementation of INewItemHelper<T> designed to help controllers using the NewGridItem<T> command to provide a mechanism for overriding the behaviour of creating new items in the grid

OpenAlgorithm

If the selected item was generated from an algorithm, this opens the source algorithm

OpenGridItem<T>

A view command that opens the selected items from the grid into a new layout context ( IModelLayoutDisplayer)

If the item has already been altered in the current context, it will be opened using the same IEntityUpdater context, if not it will be opened in an isolated new one.

See https://help.lemonedge.com/contexts/ for more information

OpenRelatedTransaction

ResetLayout

Resets the configured layout to the default system one - you'll need to close and open the layout if it is already open.

ResetLayout.LayoutResetSelectorParam

ResetLayout.LayoutResetSelectorParamController

RevertTransactionBase<T>

A view command that will create a task to revert a API.Core.TransactionStatus.Finalized IHeaderTransactionalEntity back to API.Core.TransactionStatus.InProgress

This will remove all gl posting entries (as they are only created at API.Core.TransactionStatus.Committed status or greater) and will revert the transaction and all child transactional entites back to inprogress

This should only be enabled against transactions that specifically support it

RunReport

A command used to execute and run a provided IReport using the UNIQUE_TASK_ID server task

SaveFilePropertyToFile

A view command that prompts the user for a file and saves the specified data to it. For example:

byte[] myFileData = GetMyFileData();
var store = new SaveFilePropertyToFile(View.Displayer,
    () => myFileData,
    () => true,
    new LemonEdge.Core.Client.CommandDecriptor("Save File", Images.ImageType.Download, "Save a copy of file.", Images.ImageType.AddIn),
    new(string, string)[] { (".net Dlls", "*.dll"), ("All Files", "*.*") },
    () => "DefaultFileName.dll");

SearchGrid

A custom view command of type Search

SingleToggleCommand

A base toggle view command that provides an implemention of the IHasToggleStatus derived from a function stating if the item is toggled, and an action to toggle it

This can be used for simple toggle states that do not need to track events or other UI wiring

SplitExistingTransaction

TaskBase

The base task command for executing any IServerTask in the system, providing a popup of parameters to the user, running it locally or remotely, and tracking the progress of the task to notify the user

ToggleMultiSelectGrid

A view command that toggles a collection view between allowing multiple selections and a single selection only.

ToggleNonZeroColumns

This command toggles the visibility of number columns that have all zeros/nulls as entries

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

ViewAllocation

A view command that given a transaction, opens a single layout popup displaying the system pivot " GetTransactionAllocations"

This is passed the transaction as an argument to automatically display the breakdown of this portfolio transaction through its allocated path

ViewCancelledItems

A view command that toggles the standard filter for a grid of transaction items between showing and hiding transactions with a status of API.Core.TransactionStatus.Cancelled.

The default view is to hide cancelled entries and sets the InternalFilter accordingly

ViewCommandExtender<T>

ViewDeactivatedGLAccountItems

A view command that toggles filter for a grid of gl accounts between showing and hiding archived accounts

ViewGLAllocation

A view command that given a gl posting, opens a single layout popup displaying the system pivot " GetTransactionAllocations"

This is passed the gl posting as an argument to automatically display the amounts through its allocated path

ViewSystemItems

A toggle view command that toggles between viewing system items as well, or just non-system items.

System items are defined as those implementing IHasVersion with IsSystem set to true

Implements the filter by setting InternalFilter accordingly

Interfaces

ICopyGridItemImplementor<T>

An interface for a view enabling the ability to add a new item to the collection of items it displays

Used by grids to allow the copying of the current selected item

ICopyItemHelper<T>

An extension interface of the INewItemHelper<T> which adds an addition for helping with copying items

IDeleteGridItemImplementor<T>

An interface implemented by grid views that allow the selection of rows, along with the removal of rows from the grid entirely

IGrid

An interface for a view that holds a collection of items that can be enumerated, such as a grid

IGridSelectionMode

An interface for grid views to implement that have a toggle status set for the changing of their SelectionMode between single and multiple

IGridSelector

An interface implemented by grids to allow rows to be selected, and to allow the system to automatically specify which rows should be selected

IItemSelector

An interface for views to implement (typically grids) that provide a mechanism for retrieving the selected items, and setting whether selections can be multiple or single

ILockableController

An interface that can be implemented by any IModelViewController to ensure it can work with the Lockable command

INewGridItemImplementor<T>

An interface for a view to enable creating new items manually by the user.

This expands on the copying (ICopyGridItemImplementor<T>) capability by adding functionality to override certain behaviour when creating a new item from scratch

INewItemHelper<T>

This interface is designed to help controllers using the NewGridItem<T> command to provide a mechanism for overriding the behaviour of creating new items in the grid

For instance this provides a mechanism that the IDocument grid controller uses to popup a file selection dialog box before creating new items linked to a file

IOpenGridItemImplementor<T>

An interface implemented by grids to allow rows to be selected, and also a possible relationship to use to open the specified item

ISearchController

Enums

GridSelectionMode

The type of selection allowed for rows of data against a grid