Class PeriodEndDataItemsController

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

Constructors

PeriodEndDataItemsController(IBaseGridRelatedCollection<IPeriodEnd, ICapitalAccountDataItem>)

Declaration
public PeriodEndDataItemsController(IBaseGridRelatedCollection<IPeriodEnd, ICapitalAccountDataItem> view)
Parameters
Type Name Description
IBaseGridRelatedCollection<IPeriodEnd, ICapitalAccountDataItem> view

Properties

AllowDeleteCommand

Indicates that by default selected entities can be deleted by the user with the delete command

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

AllowNewCommand

Indicates that by default entities can be created by the user with the new command

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

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.Accounting.ICapitalAccountDataItem>.AllowOpenCommand

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.Accounting.ICapitalAccountDataItem>.AutoSelectFirstRow

CollectionRelationshipColumnName

This is the property on the ICapitalAccountDataItem 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.Accounting.IPeriodEnd, LemonEdge.API.Entities.FinancialServices.Accounting.ICapitalAccountDataItem>.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

Methods

AlterQuery(QueryableExecuter<ICapitalAccountDataItem>)

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

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

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

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.Accounting.IPeriodEnd, LemonEdge.API.Entities.FinancialServices.Accounting.ICapitalAccountDataItem>.AlterQuery(LemonEdge.Utils.QueryableExecuter<LemonEdge.API.Entities.FinancialServices.Accounting.ICapitalAccountDataItem>)

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.Accounting.ICapitalAccountDataItem>.ColumnNames()

Implements

Extension Methods