Class PeriodEndsController
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientEntities.dll
Syntax
public class PeriodEndsController : BaseGridController<IPeriodEnd>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<IPeriodEnd>, ICopyGridItemImplementor<IPeriodEnd>, IGrid, IDeleteGridItemImplementor<IPeriodEnd>, ISearchController, IModelViewControllerConstructors
PeriodEndsController(IBaseGrid<IPeriodEnd>)
Declaration
public PeriodEndsController(IBaseGrid<IPeriodEnd> view)Parameters
| Type | Name | Description |
|---|---|---|
| IBaseGrid<IPeriodEnd> | view |
Properties
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
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 IPeriodEnd is an entity that is not a IsStandingDataEntity
Declaration
public override bool AutoOpenNewItemInTab { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
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<IPeriodEnd>)
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 IPeriodEnd is an entity with a property with a SequenceStart, in which case it is ordered by that
Declaration
protected override QueryableExecuter<IPeriodEnd> AlterQuery(QueryableExecuter<IPeriodEnd> query)Parameters
| Type | Name | Description |
|---|---|---|
| QueryableExecuter<IPeriodEnd> | query | The query for this grid to always be altered before being executed |
Returns
| Type | Description |
|---|---|
| QueryableExecuter<IPeriodEnd> | The query to be used to execute results for this grid |
Overrides
CanDelete(IPeriodEnd)
Indicates if the selected item is allowed to be deleted based on the status of the item itself
The default implementation is false, allowing specific controller implementations to provide override values
Declaration
public override Task<bool> CanDelete(IPeriodEnd item)Parameters
| Type | Name | Description |
|---|---|---|
| IPeriodEnd | item | The item to check if it can be deleted |
Returns
| Type | Description |
|---|---|
| Task<bool> | True if the specified item can be deleted |
Overrides
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 thisDeclaration
protected override IEnumerable<ControlDisplayInfoLight> ColumnNames()Returns
| Type | Description |
|---|---|
| IEnumerable<ControlDisplayInfoLight> | A list of all the columns to be dynamically created in the IBaseGrid<T> |