Class AlgorithmSheetModifierController
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientEntities.dll
Syntax
public class AlgorithmSheetModifierController : BaseGridRelatedCollectionController<IAlgorithm, IAlgorithmSheetModifier>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<IAlgorithmSheetModifier>, ICopyGridItemImplementor<IAlgorithmSheetModifier>, IGrid, IDeleteGridItemImplementor<IAlgorithmSheetModifier>, ISearchController, IModelViewControllerConstructors
AlgorithmSheetModifierController(IBaseGridRelatedCollection<IAlgorithm, IAlgorithmSheetModifier>)
Declaration
public AlgorithmSheetModifierController(IBaseGridRelatedCollection<IAlgorithm, IAlgorithmSheetModifier> view)Parameters
| Type | Name | Description |
|---|---|---|
| IBaseGridRelatedCollection<IAlgorithm, IAlgorithmSheetModifier> | view |
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 IAlgorithmSheetModifier is an entity that is not a IsStandingDataEntity
Declaration
public override bool AutoOpenNewItemInTab { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
CollectionRelationshipColumnName
This is the property on the IAlgorithmSheetModifier entities that holds a relationship value that points to the SingleItem type
This controller will automatically use that to filter the correct entities for the grid in AlterQuery(QueryableExecuter<TCollection>)
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<IAlgorithmSheetModifier>)
Additionally alters the base query alteration by ensuring all entities returned are related to the SingleItem by having their CollectionRelationshipColumnName have the same value as the SingleItem ID
This is achieved via AddRelationshipJoin(QueryableExecuter<TCollection>) which can be overidden to customise how the entities of type IAlgorithmSheetModifier are precisely related to the SingleItem if not directly through that join
Declaration
protected override QueryableExecuter<IAlgorithmSheetModifier> AlterQuery(QueryableExecuter<IAlgorithmSheetModifier> query)Parameters
| Type | Name | Description |
|---|---|---|
| QueryableExecuter<IAlgorithmSheetModifier> | query | The existing query to return all the results that will populate the grid |
Returns
| Type | Description |
|---|---|
| QueryableExecuter<IAlgorithmSheetModifier> | An altered query that also ensures all entities returned are related to the SingleItem by having their CollectionRelationshipColumnName have the same value as the SingleItem ID |
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
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
GetGridSourceItems()
Executes the query (GetCurrentQuery()) for the entities required in this grid, sets the total count (as it is different due to paging), and returns the results
Declaration
public override Task<IEnumerable<IAlgorithmSheetModifier>> GetGridSourceItems()Returns
| Type | Description |
|---|---|
| Task<IEnumerable<IAlgorithmSheetModifier>> | The result of executing the GetCurrentQuery() to return all the entities that should be displayed in this grid |
Overrides
RemoveItems(IEnumerable<IAlgorithmSheetModifier>)
Removes the specified set of items from the grid and if the items in the grid have a property marked as SequenceStart then it will decrement the ones above these deleted items to reflect their change in order
Declaration
public override Task RemoveItems(IEnumerable<IAlgorithmSheetModifier> items)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<IAlgorithmSheetModifier> | items | The items to be removed from the CurrentItems |
Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operation |
Overrides
UpdateNewItem(IAlgorithmSheetModifier)
Updates any new item created in this grid to also have the CollectionRelationshipColumnName property hold the value of the SingleItem ID
Declaration
protected override Task UpdateNewItem(IAlgorithmSheetModifier item)Parameters
| Type | Name | Description |
|---|---|---|
| IAlgorithmSheetModifier | item | The new item created for this grid |
Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operation |