Class GLAccountsController

Inheritance
object
ModelViewController
BaseGridController
BaseGridControllerAny<GLAccountWrapperWithNames>
BaseGridControllerWrapper<GLAccountWrapperWithNames, IGLAccount, IGLAccountName>
GLAccountsController
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientEntities.dll
Syntax
public class GLAccountsController : BaseGridControllerWrapper<GLAccountWrapperWithNames, IGLAccount, IGLAccountName>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<GLAccountWrapperWithNames>, ICopyGridItemImplementor<GLAccountWrapperWithNames>, IGrid, IDeleteGridItemImplementor<GLAccountWrapperWithNames>, ISearchController, IModelViewController

Constructors

GLAccountsController(IBaseGridWrapperCollection<GLAccountWrapperWithNames, IGLAccount, IGLAccountName>)

Declaration
public GLAccountsController(IBaseGridWrapperCollection<GLAccountWrapperWithNames, IGLAccount, IGLAccountName> view)
Parameters
Type Name Description
IBaseGridWrapperCollection<GLAccountWrapperWithNames, IGLAccount, IGLAccountName> 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.Accounting.GLAccountWrapperWithNames>.AllowCopyCommand

AllowDeleteCommand

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

The default is false

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

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.Accounting.GLAccountWrapperWithNames>.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 GLAccountWrapperWithNames 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.Accounting.GLAccountWrapperWithNames>.AutoOpenNewItemInTab

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

CopyItemHelper

Provides the helper class for copying existing items in the grid

Not implemented for this controller as the GLAccountWrapperWithNames may not be an entity type it knows how to copy. Must be implemented by an inheriting controller.

Declaration
protected override ICopyItemHelper<GLAccountWrapperWithNames> CopyItemHelper { get; }
Property Value
Type Description
ICopyItemHelper<GLAccountWrapperWithNames>
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.FinancialServices.Accounting.GLAccountWrapperWithNames>.CopyItemHelper

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

NewItemHelper

Provides the helper class for creating new items in the grid.

Not implemented for this controller as the GLAccountWrapperWithNames may not be an entity type it knows how to create. Must be implemented by an inheriting controller.

Declaration
protected override INewItemHelper<GLAccountWrapperWithNames> NewItemHelper { get; }
Property Value
Type Description
INewItemHelper<GLAccountWrapperWithNames>
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.FinancialServices.Accounting.GLAccountWrapperWithNames>.NewItemHelper

PivotColumnInfo

The details of the indexed property on the GLAccountWrapperWithNames type that holds all the values for the pivotted properties

This is used for every pivotted column created just with a different index for the different items from LoadPivotColumnHeaders()

Declaration
protected override (string Name, string GeneralDescription, ColumnType ColType, Type Type) PivotColumnInfo { get; }
Property Value
Type Description
(string Name, string GeneralDescription, ColumnType ColType, Type Type)
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerWrapper<LemonEdge.API.Entities.FinancialServices.Accounting.GLAccountWrapperWithNames, LemonEdge.API.Entities.FinancialServices.Accounting.IGLAccount, LemonEdge.API.Entities.FinancialServices.Accounting.IGLAccountName>.PivotColumnInfo

SelectedItemForSubViews

Returns the first selected item in the IBaseGrid<T> for any sub-views

Declaration
public override object SelectedItemForSubViews { get; }
Property Value
Type Description
object
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.FinancialServices.Accounting.GLAccountWrapperWithNames>.SelectedItemForSubViews

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.Accounting.GLAccountWrapperWithNames>.AlterColumnInfo(LemonEdge.Client.UI.API.Controls.ControlDisplayInfo)

AlterMainQuery(QueryableExecuter<IGLAccount>)

Provides the inheriting controller an opportunity to modify the query used to load the data for these IGLAccount items

Default implementation does nothing unless the type IGLAccount is an entity with a property with a SequenceStart, in which case it is ordered by that

Declaration
protected override QueryableExecuter<IGLAccount> AlterMainQuery(QueryableExecuter<IGLAccount> query)
Parameters
Type Name Description
QueryableExecuter<IGLAccount> query

The query for this grid to always be altered before being executed
Returns
Type Description
QueryableExecuter<IGLAccount>

The query to be used to execute results for this grid
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerWrapper<LemonEdge.API.Entities.FinancialServices.Accounting.GLAccountWrapperWithNames, LemonEdge.API.Entities.FinancialServices.Accounting.IGLAccount, LemonEdge.API.Entities.FinancialServices.Accounting.IGLAccountName>.AlterMainQuery(LemonEdge.Utils.QueryableExecuter<LemonEdge.API.Entities.FinancialServices.Accounting.IGLAccount>)

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

GetCopyGridCommand()

Returns the command for copying an item in the grid

Not implemented for this controller as the GLAccountWrapperWithNames may not be an entity type it knows how to copy. Must be implemented by an inheriting controller.

Declaration
protected override ViewCommand GetCopyGridCommand()
Returns
Type Description
ViewCommand

The command for copying an item in the grid
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.FinancialServices.Accounting.GLAccountWrapperWithNames>.GetCopyGridCommand()

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

LoadPivotColumnHeaders()

Loads the list of entities that should be the headers of the pivot columns for each extra column in the grid represented as an indexed property on GLAccountWrapperWithNames

Declaration
protected override Task<IEnumerable<IBaseEntity>> LoadPivotColumnHeaders()
Returns
Type Description
Task<IEnumerable<IBaseEntity>>

The list of entities that should be the headers of the pivot columns for each extra column in the grid represented as an indexed property on GLAccountWrapperWithNames
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerWrapper<LemonEdge.API.Entities.FinancialServices.Accounting.GLAccountWrapperWithNames, LemonEdge.API.Entities.FinancialServices.Accounting.IGLAccount, LemonEdge.API.Entities.FinancialServices.Accounting.IGLAccountName>.LoadPivotColumnHeaders()

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

Implements

Extension Methods