Class AllocationPathAllocationsController

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

Constructors

AllocationPathAllocationsController(IBaseGridRelatedCollection<IAllocationPath, IPathInfo>)

Declaration
public AllocationPathAllocationsController(IBaseGridRelatedCollection<IAllocationPath, IPathInfo> view)
Parameters
Type Name Description
IBaseGridRelatedCollection<IAllocationPath, IPathInfo> view

Properties

AllowCopyCommand

Indicates the command to allow selected rows to be copied by the user is included in the InitCommands(IList<ViewCommand>)

The default is false

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

AllowNewCommand

Indicates the command to allow new items to be created by the user is included in the InitCommands(IList<ViewCommand>)

The default is false if NewItemHelper is equal to null

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

AllowOpenCommand

Indicates the command to allow selected rows to be opened by the user is included in the InitCommands(IList<ViewCommand>)

The default is false

Declaration
public override bool AllowOpenCommand { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.FinancialServices.Transactions.IPathInfo>.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 IPathInfo 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.IPathInfo>.AutoOpenNewItemInTab

CollectionRelationshipColumnName

This is the property on the IPathInfo 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.BaseGridRelatedAnyCollectionController<LemonEdge.API.Entities.FinancialServices.Transactions.IAllocationPath, LemonEdge.API.Entities.FinancialServices.Transactions.IPathInfo>.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

DefaultColumnGroupIndexes

Groupings for columns to be grouped by and items have aggregation summaries of

Declaration
public override IEnumerable<int> DefaultColumnGroupIndexes { get; }
Property Value
Type Description
IEnumerable<int>
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

OpenFromRelatedColumnName

Indicates when opening a selected item in the grid, that it should not open the item itself, but rather the item referred to by the value held against this property on the type

The default value is null, indicating it should just open the item itself, but can be overridden by a derived controller to open other related items by default

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

Methods

Columns()

Provides a list of all the columns to be created against the IBaseGrid<T> by this control

The default behaviour is to enumerate ColumnNames() and create the list automatically. You can also override AlterColumnInfo(ControlDisplayInfo) to provide more detail for specific columns

Alternatively you can override this to explicitly define them
Declaration
public override IEnumerable<ControlDisplayInfo> Columns()
Returns
Type Description
IEnumerable<ControlDisplayInfo>

A list of all the columns to be created against the IBaseGrid<T> by this control
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.FinancialServices.Transactions.IPathInfo>.Columns()

GetGridSourceItems()

A function that must be implemented by inheriting classes that returns the list of items to be displayed against the grid given all active filters, sorting, searches, paging, etc

Declaration
public override Task<IEnumerable<IPathInfo>> GetGridSourceItems()
Returns
Type Description
Task<IEnumerable<IPathInfo>>

A list of items to be displayed against the grid given all active filters, sorting, searches, paging, etc
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.FinancialServices.Transactions.IPathInfo>.GetGridSourceItems()

InitAsync()

Provides the controller a chance to initialize any dependant data. Called once by the system after controller creation.

Declaration
public override Task InitAsync()
Returns
Type Description
Task

A task indicating the completion of the operation
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

Implements

Extension Methods