Search Results for

    Show / Hide Table of Contents

    Namespace LemonEdge.Client.Core.Commands

    Classes

    About

    This command executes the About system command

    Shows the about dialog box

    AddToFavourites

    This command executes the AddToFavourites system command

    Gets the current displayed item from the active layout and adds it to the list of IFavourite items for the user

    Close

    This command executes the Close system command

    Closes the current active layout

    CloseOtherTabs

    This command executes the CloseOtherTabs system command

    Closes all other open layouts that have no pending changes

    CommandExtensions

    A set of helper functions for working with EPCommand and ICommandDescriptor

    ControlCommandCreator

    A class that is implemented by a client application so that LemonEdge can create ui component buttons for LemonEdge commands as required

    This is not used internally by the LemonEdge core, but can be used by the client application (via CommandExtensions) as a central mechanism for creating, and dealing with commands to integrate into their respective UIs

    EPCommand

    The base command for all commands in the LemonEdge platform, implementing the IEPCommand interface

    Commands inheriting this can be displayed on the main menu and anywhere throughout the application. View specific commands should typically inherit from ViewCommand

    EPCommandWithDescriptor

    The base command for all commands with descriptors in the LemonEdge platform, implementing the IEPCommandWithDescriptor interface

    ExcelExportInfo

    Used to provide a popup to the user in the client allowing the selection of columns, and possible filtering of results from a entity type or sql wrapper

    ExportData

    This command executes the ExportData system command

    Exports the data from the specified entity, ISQLWrapper, or ICollectionExportable controller

    Provides appropriate parameter selection for filtering, columns, and parameters

    ExportTemplate

    This command executes the ExportTemplate system command

    Exports a file with all the correct headers and formatting for the specified entity type. Includes two rows of dummy data.

    GenerateCode

    This command executes the CodeGeneration system command

    Loads a .net 5 specified dll created against the LemonEdge API and creates the associated entity code for each EntityDefinition interface found in the dll

    Help

    This command executes the Help system command

    Loads child commands containing context sensitive help on the system, menu items, role, and active views within the active layout

    Users can customise the help using the ItemHelpURL, ContextHelpURL, LayoutHelpURL, or RoleHelpURL

    LaunchTaskService

    This command executes the LaunchTaskService system command

    Launches the task service to run locally. Only possible if the client application is directly connected to the database, can not be run through the web service.

    When running it is a complete version of the task service running locally on a separate thread. It will execute any task in the queue, not just ones created from this client.

    LoadFavourite

    This command executes the LoadFavourite system command

    A command which has each IFavourite item for this user loaded as child commands to this one which load that item when executed

    Quit

    This command executes the Quit system command

    Quits the entire application and closes everything down. If there are any pending changes the user is prompted to cancel, or save those changes first.

    RefreshAll

    This command executes the Refresh system command

    Refreshes the entire application, closing all open layouts (discarding any pending changes), stops tracking any active executing tasks, reloads the local cache and redisplays the main menu

    RefreshContext

    This command executes the RefreshTab system command

    Refreshes the current active tab if this command has a IModelLayouHost as an owner, or the actual IModelLayoutDisplayer if that is the owner

    RefreshServers

    This command executes the RefreshServers system command

    Invalidates the cache on all the services forcing them to reload. Once complete this client application itself can reload forcing it to load in the new cache from the servers.

    RemoveFromFavourites

    This command executes the RemoveFromFavourites system command

    Gets the current displayed item from the active layout and removes it from the list of IFavourite items for the user

    ResetSystemRoles

    This command executes the ResetSystemRoles system command

    Performs a RefreshServers(IModelLayoutCommon), and also runs the upgrade command for the standard system roles and teams which resets their permissions and menus.

    This also runs the same reset process for any custom AddIns that implement IDefaultMenuInserter

    Save

    This command executes the Save system command

    Saves any changes made against the active displayed layout, or specified layout, and refreshes the layout(s) when the save completes successfuly

    This also prompts the user with any custom save dialogs through IHasSaveProcessingTask implementations and tracks any tasks created during the save process so the user can see their progress

    SwitchCanvas

    This command executes the SwitchCanvas system command

    Lists all canvases the user has access to, and the main system (no canvas), as child commands.

    Executing any will switch the users context to that canvas, or main system, and perform a RefreshAll(IModelLayoutCommon) to run the system in that new canvas

    SwitchRole

    This command executes the SwitchRole system command

    Lists all roles the user has access to as child commands.

    Switches the role the current user is running in, and performs a RefreshAll(IModelLayoutCommon) to run the system under that new role

    SwitchTeam

    This command executes the SwitchTeam system command

    Lists all teams the user has access to as child commands.

    Switches the team the current user is running in, and performs a RefreshAll(IModelLayoutCommon) to run the system under that new team

    SwitchTheme

    This command executes the Theme system command

    Lists all themes the user has access to as child commands.

    Switches the theme the current user is running in, and prompts if they want to quit the application and restart in order to load in the UI changes

    SwitchUser

    This command executes the SwitchUser system command

    Launches the login dialog box again and allows the user to login with different credentials, or into an entirely new system. If sucessfull the application will reload under the new connection

    TruncateTable

    This command executes the TruncateTable system command

    Truncates all the tables holding data for this entity, all froeign table entries linking to it are left.

    Interfaces

    IEPCommand

    The core LemonEdge Command interface, implemented by the base EPCommand

    Inherits from System.Windows.Input.ICommand so that this can be used against any UI component in any type of client application as the command

    IEPCommandWithDescriptor

    The core LemonEdge Command interface that also includes its own detail (such as title, icon, etc) for being displayed in the (UI) via the ICommandDescriptor implementation

    IHasToggleStatus

    An interface used by IEPCommand to implement a mechanism that indicates if a command should be in its toggled state or not

    This can exist independantly of the command, so the toggle command can react to the change (wherever it maybe in the application) and update its state accordingly

    Enums

    CommandButtonType

    The type of button in the client ui.

    These can look and behave differently depending on the client application (windows app versus web browser for instance), but should have the same type of functionality

    CommandSize

    The size we want the CommandButtonType to appear as in the ui

    Some of these sizes are not relevant depending on the CommandButtonType, and some will appear differently depending on the client application anyway (windows app versus web browser for instance)

    EPCommandCustomType

    A list of command types that need to be handled specifically within the UI client application itself

    In This Article
    Back to top © LemonTree Software Ltd. All rights reserved.