Class EntityPeriodClosingsControllerBase
A standard base view that displays a list of IEntityPeriodClosing against an object entity that inherits IObjectEntityBase and has HasGL set to true
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientCore.dll
Syntax
public class EntityPeriodClosingsControllerBase : BaseGridRelatedCollectionController<IObjectEntityBase, IEntityPeriodClosing>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<IEntityPeriodClosing>, ICopyGridItemImplementor<IEntityPeriodClosing>, IGrid, IDeleteGridItemImplementor<IEntityPeriodClosing>, ISearchController, IModelViewControllerConstructors
EntityPeriodClosingsControllerBase(IBaseGridRelatedCollection<IObjectEntityBase, IEntityPeriodClosing>)
Creates a new EntityPeriodClosingsControllerBase
Declaration
public EntityPeriodClosingsControllerBase(IBaseGridRelatedCollection<IObjectEntityBase, IEntityPeriodClosing> view)Parameters
| Type | Name | Description |
|---|---|---|
| IBaseGridRelatedCollection<IObjectEntityBase, IEntityPeriodClosing> | view | The IBaseGridRelatedCollection view implementation using the UI components of the client application |
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
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 IEntityPeriodClosing is an entity that is not a IsStandingDataEntity
Declaration
public override bool AutoOpenNewItemInTab { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
CollectionRelationshipColumnName
Specified that the property EntityID holds the relationship from an IEntityPeriodClosing to the parent IObjectEntityBase SingleItem of this view
Declaration
public override string CollectionRelationshipColumnName { 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<IEntityPeriodClosing>)
Orders the query results by the PeriodClosedDate
Declaration
protected override QueryableExecuter<IEntityPeriodClosing> AlterQuery(QueryableExecuter<IEntityPeriodClosing> query)Parameters
| Type | Name | Description |
|---|---|---|
| QueryableExecuter<IEntityPeriodClosing> | query | The query for all the period closings for this entity |
Returns
| Type | Description |
|---|---|
| QueryableExecuter<IEntityPeriodClosing> | The altered query that returns all period end closings for this entity |
Overrides
ColumnNames()
Adds the EntityID, and PeriodClosedDate columns to the grid
Declaration
protected override IEnumerable<ControlDisplayInfoLight> ColumnNames()Returns
| Type | Description |
|---|---|
| IEnumerable<ControlDisplayInfoLight> | The columns to be added to this grid |
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(IEntityPeriodClosing)
Sets the default period close date to today
Declaration
protected override Task UpdateNewItem(IEntityPeriodClosing item)Parameters
| Type | Name | Description |
|---|---|---|
| IEntityPeriodClosing | item | The new period end closing created by the user |
Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of this operation |