Class AllocationAmountsController

Inheritance
object
ModelViewController
BaseGridController
BaseGridControllerAny<IAllocationAmount>
BaseGridController<IAllocationAmount>
BaseGridRelatedCollectionController<IAllocationRule, IAllocationAmount>
AllocationAmountsController
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientEntities.dll
Syntax
public class AllocationAmountsController : BaseGridRelatedCollectionController<IAllocationRule, IAllocationAmount>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<IAllocationAmount>, ICopyGridItemImplementor<IAllocationAmount>, IGrid, IDeleteGridItemImplementor<IAllocationAmount>, ISearchController, IModelViewController

Constructors

AllocationAmountsController(IBaseGridRelatedCollection<IAllocationRule, IAllocationAmount>)

Declaration
public AllocationAmountsController(IBaseGridRelatedCollection<IAllocationRule, IAllocationAmount> view)
Parameters
Type Name Description
IBaseGridRelatedCollection<IAllocationRule, IAllocationAmount> view

Properties

AllocationAmountEntityTargetFilter

Declaration
public static RelatedItemSearchExecuter AllocationAmountEntityTargetFilter { get; set; }
Property Value
Type Description
RelatedItemSearchExecuter

AllowCopyCommand

Indicates that by default selected entities can be copied by the user with the copy command

Declaration
public override bool AllowCopyCommand { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridController<LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationAmount>.AllowCopyCommand

AllowOpenCommand

Indicates that by default selected entities can be opened by the user with the open command

Declaration
public override bool AllowOpenCommand { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridController<LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationAmount>.AllowOpenCommand

AutoOpenNewItemInTab

Indicates when creating a new item in the grid that it should automatically be opened in a new tab as well

The default is true if the type IAllocationAmount is an entity that is not a IsStandingDataEntity

Declaration
public override bool AutoOpenNewItemInTab { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationAmount>.AutoOpenNewItemInTab

AutoSelectFirstRow

Indicates the first row of the results in this grid should automatically be selected by the view when the data is loaded and displayed

The default is false

Declaration
protected override bool AutoSelectFirstRow { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationAmount>.AutoSelectFirstRow

CollectionRelationshipColumnName

This is the property on the IAllocationAmount entities that holds a relationship value that points to the SingleItem type

This controller will automatically use that to filter the correct entities for the grid in AlterQuery(QueryableExecuter<TCollection>)

Declaration
public override string CollectionRelationshipColumnName { get; }
Property Value
Type Description
string
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridRelatedCollectionController<LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationRule, LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationAmount>.CollectionRelationshipColumnName

ContextHelpURL

An optional associated url of a help file for the view this controller works with

Declaration
public override string ContextHelpURL { get; }
Property Value
Type Description
string
Overrides

DefaultSearchColumn

The name of the column to use in the default search of text in the grid

Declaration
protected override string DefaultSearchColumn { get; }
Property Value
Type Description
string
Overrides

PopulateNewFromLookupColumnName

Returns OpenFromRelatedColumnName

Declaration
public override string PopulateNewFromLookupColumnName { get; }
Property Value
Type Description
string
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridRelatedCollectionController<LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationRule, LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationAmount>.PopulateNewFromLookupColumnName

PreventDuplicateLookupIDs

If PopulateNewFromLookupColumnName is set and this is true then the system will ensure that new items are only created for selected entities that there are no current existing items with those values too

In other words this prevents duplication of items in the collection that have the same value for the PopulateNewFromLookupColumnName property on entity type IAllocationAmount

Declaration
public override bool PreventDuplicateLookupIDs { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationAmount>.PreventDuplicateLookupIDs

Methods

AlterColumnInfo(ControlDisplayInfo)

Provides an inheriting controller the opportunity to alter the specified column before it is added to the IBaseGrid<T>

This is used in conjunction with columns defined via ColumnNames(), rather than Columns() which explicitly defines all information

The default operation provides a CustomComboItems if the column is against a property that is a link to an entity type (IsEntityLink)
Declaration
protected override void AlterColumnInfo(ControlDisplayInfo info)
Parameters
Type Name Description
ControlDisplayInfo info

The definition of the column that can be updated before being created in the IBaseGrid<T>
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationAmount>.AlterColumnInfo(LemonEdge.Client.UI.API.Controls.ControlDisplayInfo)

AlterLoadedItems(IEnumerable<IAllocationAmount>)

Provides a mechanism for an inhetiring class to alter all the loaded items before they are sent to the GridView to be displayed

Declaration
protected override Task<IEnumerable<IAllocationAmount>> AlterLoadedItems(IEnumerable<IAllocationAmount> items)
Parameters
Type Name Description
IEnumerable<IAllocationAmount> items

The items loaded for display into the GridView
Returns
Type Description
Task<IEnumerable<IAllocationAmount>>
Overrides

AlterQuery(QueryableExecuter<IAllocationAmount>)

Additionally alters the base query alteration by ensuring all entities returned are related to the SingleItem by having their CollectionRelationshipColumnName have the same value as the SingleItem ID

This is achieved via AddRelationshipJoin(QueryableExecuter<TCollection>) which can be overidden to customise how the entities of type IAllocationAmount are precisely related to the SingleItem if not directly through that join

Declaration
protected override QueryableExecuter<IAllocationAmount> AlterQuery(QueryableExecuter<IAllocationAmount> query)
Parameters
Type Name Description
QueryableExecuter<IAllocationAmount> query

The existing query to return all the results that will populate the grid
Returns
Type Description
QueryableExecuter<IAllocationAmount>

An altered query that also ensures all entities returned are related to the SingleItem by having their CollectionRelationshipColumnName have the same value as the SingleItem ID
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridRelatedCollectionController<LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationRule, LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationAmount>.AlterQuery(LemonEdge.Utils.QueryableExecuter<LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationAmount>)

ColumnNames()

A list of all the columns to be dynamically created in the IBaseGrid<T>

This is used by the system to create the actual ControlDisplayInfo classes required from the Columns() property

You can override this to provide a simple definition of each column (combined with AlterControlInfo(ControlDisplayInfo) for more detail), or you can just override Columns() and ignore this
Declaration
protected override IEnumerable<ControlDisplayInfoLight> ColumnNames()
Returns
Type Description
IEnumerable<ControlDisplayInfoLight>

A list of all the columns to be dynamically created in the IBaseGrid<T>
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationAmount>.ColumnNames()

DisplayUI()

Initializes the grid, and creates every ControlDisplayInfo in the defined Columns() and creates them on the grid

Then loads the data for the grid accounting for all view sorting, filtering, searching and paging, and loads the results into the grid as an observable collection

Declaration
public override Task DisplayUI()
Returns
Type Description
Task

A task indicating the completion of the operation
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationAmount>.DisplayUI()

OnTrackedItemChanged(object, string)

Provids a mechanism for handling changes for any item in the context

By default this is used to apply changes made to a selected item automatically to all other selected items in the grid (if multi-select is enabled)

Declaration
protected override void OnTrackedItemChanged(object item, string propName)
Parameters
Type Name Description
object item

The item that changed
string propName

The property name of the changed value
Overrides

UpdateNewItem(IAllocationAmount)

Updates any new item created in this grid to also have the CollectionRelationshipColumnName property hold the value of the SingleItem ID

Declaration
protected override Task UpdateNewItem(IAllocationAmount item)
Parameters
Type Name Description
IAllocationAmount item

The new item created for this grid
Returns
Type Description
Task

A task indicating the completion of the operation
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridRelatedCollectionController<LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationRule, LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationAmount>.UpdateNewItem(LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationAmount)

Implements

Extension Methods