Class FolderAllocationMethodsController

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

Constructors

FolderAllocationMethodsController(IBaseGridRelatedCollection<IFolder, IAllocationMethod>)

Declaration
public FolderAllocationMethodsController(IBaseGridRelatedCollection<IFolder, IAllocationMethod> view)
Parameters
Type Name Description
IBaseGridRelatedCollection<IFolder, IAllocationMethod> view

Properties

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.IAllocationMethod>.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 IAllocationMethod 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.IAllocationMethod>.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.IAllocationMethod>.AutoSelectFirstRow

CollectionRelationshipColumnName

This is the property on the IAllocationMethod 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.Data.IFolder, LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationMethod>.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

DisplayIfNull

Indicates that even if the item is null the view should still update and display a null value. Default value is false.

Declaration
public override bool DisplayIfNull { get; }
Property Value
Type Description
bool
Overrides

ViewAllFolders

Declaration
public bool ViewAllFolders { get; set; }
Property Value
Type Description
bool

Methods

AlterQuery(QueryableExecuter<IAllocationMethod>)

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 IAllocationMethod are precisely related to the SingleItem if not directly through that join

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

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

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.Data.IFolder, LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationMethod>.AlterQuery(LemonEdge.Utils.QueryableExecuter<LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationMethod>)

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.IAllocationMethod>.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.IAllocationMethod>.DisplayUI()

GetCanWrite(object)

Declaration
protected override Task<bool> GetCanWrite(object item)
Parameters
Type Name Description
object item
Returns
Type Description
Task<bool>
Overrides

InitCommands(IList<ViewCommand>)

Adds the following commands, if the associated AllowXXXCommand property returns true: A public toggle, multi-select row, open, column visiblitiy, transfer visible, search, view cancelled, view system, export, new, copy, move up/down, xml export, and delete commands

Declaration
protected override void InitCommands(IList<ViewCommand> commands)
Parameters
Type Name Description
IList<ViewCommand> commands

The initial set of commands for this view
Overrides

UpdateNewItem(IAllocationMethod)

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(IAllocationMethod item)
Parameters
Type Name Description
IAllocationMethod 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.Data.IFolder, LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationMethod>.UpdateNewItem(LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationMethod)

Implements

Extension Methods