Class GLAccountsOnlyController

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

Constructors

GLAccountsOnlyController(IBaseGrid<IGLAccount>)

Declaration
public GLAccountsOnlyController(IBaseGrid<IGLAccount> view)
Parameters
Type Name Description
IBaseGrid<IGLAccount> view

Properties

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.Accounting.IGLAccount>.AllowCopyCommand

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.IGLAccount>.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.IGLAccount>.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.IGLAccount>.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 IGLAccount 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.IGLAccount>.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

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

ExpandDefaultGroups

Indicates groups should be expanded by default - false by default

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

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

AlterQuery(QueryableExecuter<IGLAccount>)

Provides the inheriting controller an opportunity to modify the query used to load the data for this IBaseGrid<T>

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> AlterQuery(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.BaseGridControllerAny<LemonEdge.API.Entities.FinancialServices.Accounting.IGLAccount>.AlterQuery(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.IGLAccount>.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.Accounting.IGLAccount>.DisplayUI()

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

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