Class StepChangeAlgorithmsController
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientEntities.dll
Syntax
public class StepChangeAlgorithmsController : BaseGridRelatedCollectionController<IStepChange, IStepChangeAlgorithm>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<IStepChangeAlgorithm>, ICopyGridItemImplementor<IStepChangeAlgorithm>, IGrid, IDeleteGridItemImplementor<IStepChangeAlgorithm>, ISearchController, ILockableController, IModelViewControllerConstructors
StepChangeAlgorithmsController(IBaseGridRelatedCollection<IStepChange, IStepChangeAlgorithm>)
Declaration
public StepChangeAlgorithmsController(IBaseGridRelatedCollection<IStepChange, IStepChangeAlgorithm> view)Parameters
| Type | Name | Description |
|---|---|---|
| IBaseGridRelatedCollection<IStepChange, IStepChangeAlgorithm> | 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
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 IStepChangeAlgorithm is an entity that is not a IsStandingDataEntity
Declaration
public override bool AutoOpenNewItemInTab { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
CanWrite
Indicates if the user currently has permissions to edit the displayed item
Default to false if the main displayed item for this layout has read only set to true ( ReadOnly). Or loads the permissions for the item
Declaration
public override bool CanWrite { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
CollectionRelationshipColumnName
This is the property on the IStepChangeAlgorithm 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
LockableHandler
The implementation that specified if this view can be edited/locked
Declaration
public ILockable LockableHandler { get; }Property Value
| Type | Description |
|---|---|
| ILockable |
OpenFromRelatedColumnName
Indicates when opening a selected item in the grid, that it should not open the item itself, but rather the item referred to by the value held against this property on the type
The default value is null, indicating it should just open the item itself, but can be overridden by a derived controller to open other related items by default
Declaration
public override string OpenFromRelatedColumnName { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
PreventDuplicateLookupIDs
If PopulateNewFromLookupColumnName is set and this is true then the system will ensure that new items are only created for selected entities that there are no current existing items with those values too
In other words this prevents duplication of items in the collection that have the same value for the PopulateNewFromLookupColumnName property on entity type IStepChangeAlgorithm
Declaration
public override bool PreventDuplicateLookupIDs { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
StepChangeMovementFilter
Declaration
public static RelatedItemSearchExecuter StepChangeMovementFilter { get; set; }Property Value
| Type | Description |
|---|---|
| RelatedItemSearchExecuter |
Methods
AlterQuery(QueryableExecuter<IStepChangeAlgorithm>)
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 IStepChangeAlgorithm are precisely related to the SingleItem if not directly through that join
Declaration
protected override QueryableExecuter<IStepChangeAlgorithm> AlterQuery(QueryableExecuter<IStepChangeAlgorithm> query)Parameters
| Type | Name | Description |
|---|---|---|
| QueryableExecuter<IStepChangeAlgorithm> | query | The existing query to return all the results that will populate the grid |
Returns
| Type | Description |
|---|---|
| QueryableExecuter<IStepChangeAlgorithm> | 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<IStepChangeAlgorithm>> GetGridSourceItems()Returns
| Type | Description |
|---|---|
| Task<IEnumerable<IStepChangeAlgorithm>> | The result of executing the GetCurrentQuery() to return all the entities that should be displayed in this grid |
Overrides
RemoveItems(IEnumerable<IStepChangeAlgorithm>)
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<IStepChangeAlgorithm> items)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<IStepChangeAlgorithm> | items | The items to be removed from the CurrentItems |
Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operation |
Overrides
UpdateLocked()
Updates the view itself to reflect the lock status of this controller, ensuring all the controls conform to them
Declaration
public void UpdateLocked()UpdateNewItem(IStepChangeAlgorithm)
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(IStepChangeAlgorithm item)Parameters
| Type | Name | Description |
|---|---|---|
| IStepChangeAlgorithm | item | The new item created for this grid |
Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operation |