Class TransfersController
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientEntities.dll
Syntax
public class TransfersController : BaseGridController<ITransfer>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<ITransfer>, ICopyGridItemImplementor<ITransfer>, IGrid, IDeleteGridItemImplementor<ITransfer>, ISearchController, IModelViewControllerConstructors
TransfersController(IBaseGrid<ITransfer>)
Declaration
public TransfersController(IBaseGrid<ITransfer> view)Parameters
| Type | Name | Description |
|---|---|---|
| IBaseGrid<ITransfer> | view |
Properties
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<ITransfer>)
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 ITransfer is an entity with a property with a SequenceStart, in which case it is ordered by that
Declaration
protected override QueryableExecuter<ITransfer> AlterQuery(QueryableExecuter<ITransfer> query)Parameters
| Type | Name | Description |
|---|---|---|
| QueryableExecuter<ITransfer> | query | The query for this grid to always be altered before being executed |
Returns
| Type | Description |
|---|---|
| QueryableExecuter<ITransfer> | The query to be used to execute results for this grid |
Overrides
CanDelete(ITransfer)
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(ITransfer item)Parameters
| Type | Name | Description |
|---|---|---|
| ITransfer | 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> |
Overrides
UpdateNewItem(ITransfer)
Provides an inheriting controller an opportunity to alter the newly created item by the grid before it is added to the IBaseGrid<T> itself
By default this ensures the item has the next maximum sequence number if the item is an entity that has a property with a SequenceStart
Declaration
protected override Task UpdateNewItem(ITransfer item)Parameters
| Type | Name | Description |
|---|---|---|
| ITransfer | item | The newly created item to be added to the grid |
Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operation |