Search Results for

    Show / Hide Table of Contents

    Namespace LemonEdge.Client.Core.Views.Core

    Classes

    AuditHistoryToolWindow

    The tool window Item used to display a AuditHistory tool window

    BaseDefaultSingleViewController<T>

    The core controller for handling the IBaseDefaultSingleView<T> view

    This is the main controller for creating a view with custom controls for editing any specified entity of type T

    Both this controller and the BaseGridController view have a similar mechanism for creating controls dynamically within the UI

    BaseDefaultSingleViewExtenderController<DISPLAYTYPE, EXTENDEDTYPE>

    The core controller for providing a IBaseDefaultSingleView<T> against an entity that extends ( IsTypeExtender) another type

    If the DISPLAYTYPE does not exist this will temporarily create one and only add it to pending changes when the user actually modifies the temporary item itself

    BaseDefaultSingleViewRelatedItemController<TParent, TSingleItem>

    BaseDefaultSingleViewRelatedItemCustomController<Parent, Single>

    BaseDynamicLayoutViewController

    BaseDynamicLayoutViewController<T>

    BaseDynamicLayoutViewEnumerator

    BaseGridAnyRelatedAnyCollectionController<T>

    The base generic grid controller which works with the IBaseGridAnyRelatedCollection<T> view and displays an entity type as rows in the grid that are all related to an other object

    This is the main base controller for creating grids, and dynamically creating their columns, for any entity in the system that is related to another object. It is different from BaseGridRelatedAnyCollectionController<TSingleItem, TCollection> or BaseGridRelatedCollectionController<TSingleItem, TCollection> as that single item type must be the same, where as this can have a parent that can be of different types allowing it to work against any entity parent

    Both this controller and the BaseDefaultSingleViewController<T> view have a similar mechanism for creating controls dynamically within the UI

    BaseGridAnyRelatedCollectionController<T>

    The base generic grid controller which works with the IBaseGridAnyRelatedCollection<T> view and displays an entity type as rows in the grid that are all related to an other object

    This is the main base controller for creating grids, and dynamically creating their columns, for any entity in the system that is related to another object. It is different from BaseGridRelatedAnyCollectionController<TSingleItem, TCollection> or BaseGridRelatedCollectionController<TSingleItem, TCollection> as that single item type must be the same, where as this can have a parent that can be of different types allowing it to work against any entity parent

    Both this controller and the BaseDefaultSingleViewController<T> view have a similar mechanism for creating controls dynamically within the UI

    BaseGridController

    The base non-type generic version of BaseGridControllerAny<T>/BaseGridController<T> which works with the IBaseGrid<T> view

    This is the main base controller for creating grids, and dynamically creating their columns, for any object in the system

    Both this controller and the BaseDefaultSingleViewController<T> view have a similar mechanism for creating controls dynamically within the UI

    BaseGridControllerAny<T>

    The base generic grid controller which works with the IBaseGrid<T> view and displays any type of object as rows in the grid

    This is the main base controller for creating grids, and dynamically creating their columns, for any object in the system. The BaseGridController<T> is used specifically for entities inheriting from IBaseEntity

    Both this controller and the BaseDefaultSingleViewController<T> view have a similar mechanism for creating controls dynamically within the UI

    BaseGridControllerWrapper<TWrapper, TMain, TPivot>

    The base wrapper grid controller which works with the IBaseGridWrapperCollection<TWrapper, TMain, TPivot> view displaying wrapped items with pivotted columns in the wrapper

    This is the main controller for creating grids of any wrapped item in the system that holds pivotted columns of another item in the system

    Both this controller and the BaseDefaultSingleViewController<T> view have a similar mechanism for creating controls dynamically within the UI

    BaseGridController<T>

    The base generic grid controller which works with the IBaseGrid<T> view and displays an entity type as rows in the grid

    This is the main base controller for creating grids, and dynamically creating their columns, for any entity in the system. The BaseGridControllerAny<T> is used objects that are not entities inheriting from IBaseEntity

    Both this controller and the BaseDefaultSingleViewController<T> view have a similar mechanism for creating controls dynamically within the UI

    BaseGridCustomController<T>

    The system controller used for automatically creating a IBaseGrid<T> according to a ICustomGrid definition

    Uses the GridViewControllerCustomViewParams parameter for the view to determine the ICustomGrid to load the defintion of

    BaseGridCustomRelatedCollectionController<SI, T>

    The system controller used for automatically creating a IBaseGrid<T> according to a ICustomGrid definition

    Uses the GridViewControllerCustomViewParams parameter for the view to determine the ICustomGrid to load the defintion of

    BaseGridRelatedAnyCollectionController<TSingleItem, TCollection>

    The base generic grid controller which works with the IBaseGridRelatedCollection<TParentSingleItem, TCollection> view and displays an object type as rows in the grid that are all related to an other entity

    This is the main base controller for creating grids, and dynamically creating their columns, for any object in the system that is related to another entity. It is different from BaseGridRelatedCollectionController<TSingleItem, TCollection> as that only displays entities, and BaseGridControllerAny<T> as that can have multiple different types of parent it is related to where as this must be of type TSingleItem

    Both this controller and the BaseDefaultSingleViewController<T> view have a similar mechanism for creating controls dynamically within the UI

    BaseGridRelatedCollectionController<TSingleItem, TCollection>

    The base generic grid controller which works with the IBaseGridRelatedCollection<TParentSingleItem, TCollection> view and displays an entity type as rows in the grid that are all related to an other entity

    This is the main base controller for creating grids, and dynamically creating their columns, for any entity in the system that is related to another entity. It is different from BaseGridRelatedAnyCollectionController<TSingleItem, TCollection> as that can display any object, and BaseGridControllerAny<T> as that can have multiple different types of parent it is related to where as this must be of type TSingleItem

    Both this controller and the BaseDefaultSingleViewController<T> view have a similar mechanism for creating controls dynamically within the UI

    BaseTreeViewAnyController<T>

    The controller for handling the IBaseTreeView<T> view

    This controller/view allows the selection of entities of type T that can be used for sub-views accessing the SelectedItemForSubViews.

    Thus all areas grids can be used (such as the default lookup views for selecting items for single lookup controls) this view can also be used instead

    BaseTreeViewController<T>

    BaseTreeViewLabelParam

    BaseTreeViewLabelParamController

    BaseTreeViewRelatedController<SI, T>

    A base controller for handling the IBaseTreeView<T> view for all entities related to a parent item

    ChartViewController

    The controller for handling the IChartBase view

    ChildTypeParam

    ChildTypeParamController

    CollectionItemAny<T>

    CollectionItem<T>

    The item that is used for an Item in a DisplayableItemDescriptorForCollection<T> instance

    This item simply indicates that this is the type of entity to be loaded as a collection - it does not load anything itself so has no cost. That is the responsibility of the views in the IModelLayoutDisplayer for this item

    The entity type T will be displayed as a collection

    CommentsToolWindow

    The tool window Item used to display a Comments tool window

    ControlDisplayInfoFactory

    CustomFormatHelper

    A helper class for returning the correct .net culture string format for the specified ui CustomDateTimeFormat

    CustomSettingsItemLayoutInfoAttribute

    Used with any type inheriting CustomSettingsItem to indicate the valid types of layouts it can be displayed against

    DashboardDisplayerItem

    The item that is used for an Item in a DisplayableItemDescriptorForCustomSettings instance

    This item specifies that we want to load a custom layout which can display any custom design - a homepage/dashboard

    DataSourceSearchDisplayerItem

    The item that is used for an Item in a DisplayableItemDescriptorForCustomSettings instance

    This item specifies that we want to load the Data Source Search functionality that has custom views for running a aspecific custom query and displaying the results to the user

    This item also has a custom DataSourceSearchParam associated parameter for default initial search parameters

    DataSourceSearchParam

    The custom search parameter for the DataSourceSearchDisplayerItem used in the DisplayableItemDescriptorForCustomSettings displayable item descriptor

    DataSourceSearchParamController

    The controller for editing the DataSourceSearchParam in a popup single parameter window

    DataSourcesToolWindow

    The tool window Item used to display a DataSources tool window

    DisplayableItemDescriptorFactory

    DisplayableItemDescriptorForCollectionAny<T>

    The DisplayableItemDescriptor for an item that should display a collection of entity types

    The Item is not the entity collection itself, that is loaded by the views however they like, simply a CollectionItem class that represents what type of collection should be loaded and displayed

    DisplayableItemDescriptorForCollectionParams

    Optional parameters that can be associated with the ItemParams for a DisplayableItemDescriptorForCollection<T>

    These provide extra settings for filtering the displayed collection to a set of specific entities

    DisplayableItemDescriptorForCollection<T>

    The DisplayableItemDescriptor for an item that should display a collection of entity types

    The Item is not the entity collection itself, that is loaded by the views however they like, simply a CollectionItem class that represents what type of collection should be loaded and displayed

    DisplayableItemDescriptorForCustomSettings

    The DisplayableItemDescriptor for a custom item of any type

    The Item is a CustomSettingsItem class that represents the item, label, image, and layout that should be used for loading and displaying this item

    This allows you to completely define custom objects (that do not even derive from IBaseEntity), all that can operate within a custom defined layout

    DisplayableItemDescriptorForToolWindow

    The DisplayableItemDescriptor for a tool window item that typically displays items relevant to the active IModelLayoutDisplayer it is working against

    The Item is not the active layout displayer, that is loaded by the tool window views however they like (usually inheriting ModelToolWindowController), simply a ToolWindowItem class that represents what type of tool window should be loaded and displayed

    DisplayableItemDescriptorSingle<T>

    The DisplayableItemDescriptor for an instance of an entity type T

    The Item is the entity itself

    DocumentsToolWindow

    The tool window Item used to display a Documents tool window

    EntityTagsToolWindow

    The tool window Item used to display a EntityTags tool window

    GridColumnGroup

    A class used to represent the possible grouping headers for columns in the IBaseGrid<T> itself

    This is heiarchical allowing multiple grouping levels

    Columns within the Columns() definition can refer to the UniqueKey to indicate which column header grouping they should reside within

    GridControllerNotMappedPropertyFilter

    GridPageRowCountParam

    GridPageRowCountParamController

    GridViewControllerCustomViewParams

    The parameters for the IBaseGrid<T> when used with a BaseGridCustomController<T> indicating which ICustomGrid definition should be loaded in the view itself

    GridViewControllerCustomViewParamsController

    The controller for editing the GridViewControllerCustomViewParams in a popup single parameter window

    We do not need an associated IViewSerializedParamDefaultEditor implementation as this is a standard popup single parameter editor. We only need that if it has a custom editor

    ItemTasksToolWindow

    The tool window Item used to display a ItemTasks tool window

    KeepBaseChildPropertiesInSync

    LayoutDisplayerToolWindow

    The tool window Item used to display a LayoutDesigner tool window

    ModelLayoutDisplayerController

    The main controller for any IModelLayoutDisplayer ui client application component that contains a custom layout and is responsible for displaying and working with an item

    ModelLayoutHostController

    The main controller for any IModelLayoutHost view which can contain multiple instances of IModelLayoutDisplayer

    ModelLayoutHostTools

    ModelToolWindowController

    An base controller for any view that is purely hosted within a tool window (see https://help.lemonedge.com/tool-windows/) and works against a ToolWindowItem

    NotificationsToolWindow

    The tool window Item used to display a Notifications tool window

    PermissionsToolWindow

    The tool window Item used to display a Permissions tool window

    RelationshipsToolWindow

    The tool window Item used to display a Relationships tool window

    SafeStatusToolWindow

    The tool window Item used to display a SafeStatus tool window

    SchemaDisplayerItem

    The item that is used for an Item in a DisplayableItemDescriptorForCustomSettings instance

    This item specifies that we want to load the schema layout for displaying the database schema for all entities in the system

    SingleViewControllerCustomViewParams

    The parameters for the IBaseDefaultSingleView<T> when used with a BaseDefaultSingleViewCustomController<T> indicating which ICustomView definition should be loaded in the view itself

    SingleViewControllerViewParamsController

    The controller for editing the SingleViewControllerCustomViewParams in a popup single parameter window

    We do not need an associated IViewSerializedParamDefaultEditor implementation as this is a standard popup single parameter editor. We only need that if it has a custom editor

    ToolWindowItemForSingleTabOrGridSelectedItem

    The base item that is used for an Item in a DisplayableItemDescriptorForToolWindow instance that works against either the IModelLayoutDisplayer main displayed item, or the current selected item within a grid within the layout

    TreeViewControllerCustomViewParams

    The parameters for the IBaseTreeView<T> when used with a BaseTreeViewCustomController<T> indicating which ICustomTree definition should be loaded in the view itself

    ViewDescriptorEnumeratorFactory

    ViewDescriptorInstance

    A class responsible for holding the description of an instance of a IModelView to be created within a layout

    This includes an custom parameters for the view itself along with parameters for the type of view

    ViewDescriptorInstanceFactory

    A factory for generating ViewDescriptorInstances.

    ViewSerializedParam

    The root parameter type that all Param must inherit from. By default all views have this parameter type.

    Custom types can be provided for by marking a IModelView with a ViewDescriptorEnumerator which specifies the parameter type for each ViewDescriptorInstance it returns

    They can also be specified using the LemonEdge.Client.Core.Views.Core.ViewSerializedParamAttribute which a ViewDescriptorEnumerator can use, such as with the LemonEdge.Client.Core.Views.Core.IBaseGrid<T> enumerator which looks for this attribute to create custom parameters for the view descriptor instance

    ViewSerializedParamAttribute

    An attribute that can be placed against a view controller to indicate the type of parameter (inheriting from ViewSerializedParam) the view itself uses

    Typically this can be indicated using the ViewDescriptorAttribute against the IModelView itself using the ViewDescriptorEnumerator option

    However for views that are generic, although the view maybe the same there maybe many different parameter types depending on the generic type

    For instance the BaseGridController<T> works with the IBaseGrid<T> view. Any implementation of the controller can be marked with this attribute so the ViewDescriptorEnumerator can retrieve the correct parameter type for that grid controller

    You can use this in your own ViewDescriptorEnumerator, or against any grid controller which already looks for this attribute. i.e. the SQLWrapperResultsController uses this to specify it uses the SQLWrapperResultsViewParams

    ViewSerializedParamController

    This is the controller for editing all ViewSerializedParam parameters stored against a Param

    This is accessible to the user when using the LayoutDesigner and editing the properties of any view

    This controller also provides a way to edit the custom properties of any parameter that inherits from ViewSerializedParam

    ViewSerializedParamExtensions

    WatchersToolWindow

    The tool window Item used to display a Watchers tool window

    Interfaces

    IBaseDefaultSingleViewRelatedItem<TParentSingleItem, TSingle>

    IBaseDefaultSingleView<T>

    The standard single entity item view that can dynamically create appropriate controls as required from an implementation of the BaseDefaultSingleViewController<T>

    This is the core view for creating views for any entity in the system

    Both this view and the IBaseGrid<T> view have a similar mechanism for creating controls dynamically within the UI

    IBaseDynamicLayoutView<T>

    IBaseGrid

    A common set of functionality that is not type specific that the IBaseGrid<T> view implements in order to be accessible without knowing the generic type the grid works with

    IBaseGridAnyRelatedAnyCollection<T>

    The standard base grid view implementation for displaying entity items related to a main object, and that inherits all the functionality of dynamically creating apropriate columns from the IBaseGrid<T>

    This is the core view for creating grids of any entity in the system that are related to another object in the system. It is different from IBaseGridRelatedCollection<TParentSingleItem, TCollection> as that single item type must be the same, where as this can have a parent that can be of different types allowing it to owkr against any entity parent

    Both this view and the IBaseDefaultSingleView<T> view have a similar mechanism for creating controls dynamically within the UI

    IBaseGridAnyRelatedCollection<T>

    The standard base grid view implementation for displaying entity items related to a main object, and that inherits all the functionality of dynamically creating apropriate columns from the IBaseGrid<T>

    This is the core view for creating grids of any entity in the system that are related to another object in the system. It is different from IBaseGridRelatedCollection<TParentSingleItem, TCollection> as that single item type must be the same, where as this can have a parent that can be of different types allowing it to owkr against any entity parent

    Both this view and the IBaseDefaultSingleView<T> view have a similar mechanism for creating controls dynamically within the UI

    IBaseGridController

    A common interface that all implementations of BaseGridController provide access to which manipulate the IBaseGrid<T> view

    IBaseGridRelatedCollection<TParentSingleItem, TCollection>

    The standard base grid view implementation for displaying entity items related to another entity item, and that inherits all the functionality of dynamically creating appropriate columns from the IBaseGrid<T>

    This is the core view for creating grids of any entity in the system that are related to another entity in the system, it is different from IBaseGridAnyRelatedCollection<T> as that can have multiple different types of parent it is related to where as this must be of type TParentSingleItem

    Both this view and the IBaseDefaultSingleView<T> view have a similar mechanism for creating controls dynamically within the UI

    IBaseGridWrapperCollection<TWrapper, TMain, TPivot>

    The standard base grid view implementation for displaying wrapped items with pivoted columns in the wrapper, and that inherits all the functionality of dynamically creating appropriate columns from the IBaseGrid<T>

    This is the core view for creating grids of any wrapped item in the system that holds pivotted columns of another item in the system

    Both this view and the IBaseDefaultSingleView<T> view have a similar mechanism for creating controls dynamically within the UI

    IBaseGrid<T>

    The standard object grid view that can dynamically create appropriate columns as required from an implementation of the BaseGridController<T>

    This is the core view for creating grids for any object in the system

    Both this view and the IBaseDefaultSingleView<T> view have a similar mechanism for creating controls dynamically within the UI

    IBaseTreeViewWithExpansion<T>

    Optionally enhances the IBaseTreeView<T> with the capability to fully expand all tree nodes at once

    IBaseTreeView<T>

    The standard tree view used by the BaseTreeViewController<T> for displaying a heirarchical set of data as a tree view

    ICollectionExportable

    An interface that allows a controller the possibility of implementing that determines what can be exported from the controller when the ExportData command is used

    Grid controllers implement this to allow the export of just the data in the grid rather than re-running data from the server

    ICustomSettingsItemLayoutInfoParameters

    An implementation that provides all possible parameters for a custom layout.

    Specifed from CustomSettingsItemLayoutInfoAttribute

    IDisplayableDescriptorPossibleLayouts

    An interface that must be implemented by a constructable class for each DisplayableItemDescriptor implementation detailing the possible layout combinations that it works with

    ILayoutDesignConfigure

    If the client application IModelLayoutDisplayer also implements this interface then that allows the user to configure the layouts using the LayoutDesigner ( https://help.lemonedge.com/tool-window-layout-designer/)

    This enables the designer to manipulate the layout by adding/removing/moving/changing views and tabs within the layout itself

    IRelatedItemQueryFilterInterceptor

    An interface that provides the ability for a dependant IAddIn to customize the filters that occur on controls in standard system views.

    The standard system views that look for any implementation of this interface are:

    • Allocation Rules: Requires a ForEntityType of IAllocationAmount to alter the entities allowed for the allocation amount entity id lookup
    • Gl Posting Allocations: Requires a ForEntityType of IGLPostingAllocated to alter the entities allowed for the gl posting allocation entity id lookup
    • Transaction Value Allocations: Requires a ForEntityType of ITransactionAllocated to alter the entities allowed for the transaction allocation entity id lookup
    • Period End Adjusted Data Items: Requires a ForEntityType of ICapitalAccountDataItem to alter the entities allowed for the capital account data item entity id lookup
    • Transfer View: Requires a ForEntityType of ITransfer to alter the entities allowed for the transfer source entity id lookup
    • Transfer Target View: Requires a ForEntityType of ITransferTargetPartner to alter the entities allowed for the transfer target entity id lookup

    IViewSerializedParamDefaultEditor

    If a IModelView has any parameters (defined using Param) the type must inherit ViewSerializedParam

    By default it is assumed the parameters have an associated ParamSingleViewerController<T> and the system presents a popup editor using that

    This interface provides a custom way of editing those parameters with a custom parameter view. In order for the system to always be able to edit these parameters from anywhere the IViewSerializedParamDefaultEditor<T> should be implemented

    IViewSerializedParamDefaultEditor<T>

    If a IModelView has any parameters (defined using Param) the type must inherit ViewSerializedParam

    By default it is assumed the parameters have an associated ParamSingleViewerController<T> and the system presents a popup editor using that

    This interface provides a custom way of editing those parameters with a custom parameter view.

    Enums

    CustomDateTimeFormat

    An enumeration of the custom date time formats that can be used as a Format in the controls dynamically created in the client ui

    In this article
    Back to top © LemonEdge Technologies. All rights reserved.