public class AlgorithmRunStepItemsController : BaseGridRelatedAnyCollectionController<IAlgorithmRunStep, AlgorithmRunStepItemsController.AlgorithmRunStepItem>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<AlgorithmRunStepItemsController.AlgorithmRunStepItem>, ICopyGridItemImplementor<AlgorithmRunStepItemsController.AlgorithmRunStepItem>, IGrid, IDeleteGridItemImplementor<AlgorithmRunStepItemsController.AlgorithmRunStepItem>, ISearchController, IModelViewController

Constructors

AlgorithmRunStepItemsController(IBaseGridRelatedCollection<IAlgorithmRunStep, AlgorithmRunStepItem>)

Creates a new AlgorithmRunStepItems

Declaration

public AlgorithmRunStepItemsController(IBaseGridRelatedCollection<IAlgorithmRunStep, AlgorithmRunStepItemsController.AlgorithmRunStepItem> view)

Parameters

Type	Name	Description
IBaseGridRelatedCollection<IAlgorithmRunStep, AlgorithmRunStepItemsController.AlgorithmRunStepItem>	view	The IBaseGridRelatedCollection view implementation using the UI components of the client application

Properties

AllowCopyCommand

Indicates the command to allow selected rows to be copied by the user is included in the InitCommands(IList<ViewCommand>)

The default is false

Declaration

public override bool AllowCopyCommand { get; }

Property Value

Type	Description
bool

Overrides

LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.Client.Core.Views.Controllers.AlgorithmRunStepItemsController.AlgorithmRunStepItem>.AllowCopyCommand

AllowDeleteCommand

Indicates the command to allow selected rows to be deleted by the user is included in the InitCommands(IList<ViewCommand>)

The default is false

Declaration

public override bool AllowDeleteCommand { get; }

Property Value

Type	Description
bool

Overrides

LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.Client.Core.Views.Controllers.AlgorithmRunStepItemsController.AlgorithmRunStepItem>.AllowDeleteCommand

AllowExcelExport

Indicates the command to allow the grid data to be exported by the user is included in the InitCommands(IList<ViewCommand>)

The default is true

Declaration

public override bool AllowExcelExport { get; }

Property Value

Type	Description
bool

Overrides

LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.Client.Core.Views.Controllers.AlgorithmRunStepItemsController.AlgorithmRunStepItem>.AllowExcelExport

AllowNewCommand

Indicates the command to allow new items to be created by the user is included in the InitCommands(IList<ViewCommand>)

The default is false if NewItemHelper is equal to null

Declaration

public override bool AllowNewCommand { get; }

Property Value

Type	Description
bool

Overrides

LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.Client.Core.Views.Controllers.AlgorithmRunStepItemsController.AlgorithmRunStepItem>.AllowNewCommand

AllowOpenCommand

Indicates the command to allow selected rows to be opened by the user is included in the InitCommands(IList<ViewCommand>)

The default is false

Declaration

public override bool AllowOpenCommand { get; }

Property Value

Type	Description
bool

Overrides

LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.Client.Core.Views.Controllers.AlgorithmRunStepItemsController.AlgorithmRunStepItem>.AllowOpenCommand

AllowXMLImportExport

Indicates the command to allow the xml export of the data by the user is included in the InitCommands(IList<ViewCommand>)

The default is true if the type AlgorithmRunStepItemsController.AlgorithmRunStepItem derives from ISetCopier

Declaration

public override bool AllowXMLImportExport { get; }

Property Value

Type	Description
bool

Overrides

LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.Client.Core.Views.Controllers.AlgorithmRunStepItemsController.AlgorithmRunStepItem>.AllowXMLImportExport

CollectionRelationshipColumnName

This is the property on the AlgorithmRunStepItemsController.AlgorithmRunStepItem 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

LemonEdge.Client.Core.Views.Core.BaseGridRelatedAnyCollectionController<LemonEdge.API.Entities.Design.IAlgorithmRunStep, LemonEdge.Client.Core.Views.Controllers.AlgorithmRunStepItemsController.AlgorithmRunStepItem>.CollectionRelationshipColumnName

DefaultColumnGroupIndexes

Groupings for columns to be grouped by and items have aggregation summaries of

Declaration

public override IEnumerable<int> DefaultColumnGroupIndexes { get; }

Property Value

Type	Description
IEnumerable<int>

Overrides

BaseGridController.DefaultColumnGroupIndexes

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

BaseGridController.DefaultSearchColumn

ExpandDefaultGroups

Indicates groups should be expanded by default - false by default

Declaration

public override bool ExpandDefaultGroups { get; }

Property Value

Type	Description
bool

Overrides

BaseGridController.ExpandDefaultGroups

SelectedItemForSubViews

Returns the first selected item in the IBaseGrid<T> for any sub-views

Declaration

public override object SelectedItemForSubViews { get; }

Property Value

Type	Description
object

Overrides

LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.Client.Core.Views.Controllers.AlgorithmRunStepItemsController.AlgorithmRunStepItem>.SelectedItemForSubViews

Methods

AlterColumnInfo(ControlDisplayInfo)

Provides an inheriting controller the opportunity to alter the specified column before it is added to the IBaseGrid<T>

This is used in conjunction with columns defined via ColumnNames(), rather than Columns() which explicitly defines all information

The default operation provides a CustomComboItems if the column is against a property that is a link to an entity type (IsEntityLink)

Declaration

protected override void AlterColumnInfo(ControlDisplayInfo info)

Parameters

Type	Name	Description
ControlDisplayInfo	info	The definition of the column that can be updated before being created in the IBaseGrid<T>

Overrides

LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.Client.Core.Views.Controllers.AlgorithmRunStepItemsController.AlgorithmRunStepItem>.AlterColumnInfo(LemonEdge.Client.UI.API.Controls.ControlDisplayInfo)

CanDelete(AlgorithmRunStepItem)

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(AlgorithmRunStepItemsController.AlgorithmRunStepItem item)

Parameters

Type	Name	Description
AlgorithmRunStepItemsController.AlgorithmRunStepItem	item	The item to check if it can be deleted

Returns

Type	Description
Task<bool>	True if the specified item can be deleted

Overrides

BaseGridControllerAny<AlgorithmRunStepItemsController.AlgorithmRunStepItem>.CanDelete(AlgorithmRunStepItemsController.AlgorithmRunStepItem)

CanEditRowItem(AlgorithmRunStepItem)

Indicates if the user is permitted to edit the specified row item from the state of the item itself

Declaration

public override bool CanEditRowItem(AlgorithmRunStepItemsController.AlgorithmRunStepItem item)

Parameters

Type	Name	Description
AlgorithmRunStepItemsController.AlgorithmRunStepItem	item	The item to check if the user is permitted to edit

Returns

Type	Description
bool	True if the user is permitted to edit the specified row item from the state of the item itself

Overrides

BaseGridControllerAny<AlgorithmRunStepItemsController.AlgorithmRunStepItem>.CanEditRowItem(AlgorithmRunStepItemsController.AlgorithmRunStepItem)

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 this

Declaration

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

LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.Client.Core.Views.Controllers.AlgorithmRunStepItemsController.AlgorithmRunStepItem>.ColumnNames()

GetGridSourceItems()

Instead of using the query (base implementation) we return all the transactions loaded by the ITransactionProcessor for this header transaction

Declaration

public override Task<IEnumerable<AlgorithmRunStepItemsController.AlgorithmRunStepItem>> GetGridSourceItems()

Returns

Type	Description
Task<IEnumerable<AlgorithmRunStepItemsController.AlgorithmRunStepItem>>	All the transactions that have this Header Transaction as their parent

Overrides

LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.Client.Core.Views.Controllers.AlgorithmRunStepItemsController.AlgorithmRunStepItem>.GetGridSourceItems()

GetGridSourceItems(IEnumerable<AlgorithmRunStepItem>, QueryableExecuterApplyType)

Returns the currentItems with the AlterQuery(QueryableExecuter<T>) filtering applied to the results

Declaration

public override IEnumerable<AlgorithmRunStepItemsController.AlgorithmRunStepItem> GetGridSourceItems(IEnumerable<AlgorithmRunStepItemsController.AlgorithmRunStepItem> currentItems, QueryableExecuterApplyType typeToApply = QueryableExecuterApplyType.All)

Parameters

Type	Name	Description
IEnumerable<AlgorithmRunStepItemsController.AlgorithmRunStepItem>	currentItems	The current items to be displayed in the grid
QueryableExecuterApplyType	typeToApply

Returns

Type	Description
IEnumerable<AlgorithmRunStepItemsController.AlgorithmRunStepItem>	The `currentItems` with the AlterQuery(QueryableExecuter<T>) filtering applied to the results

Overrides

BaseGridControllerAny<AlgorithmRunStepItemsController.AlgorithmRunStepItem>.GetGridSourceItems(IEnumerable<AlgorithmRunStepItemsController.AlgorithmRunStepItem>, QueryableExecuterApplyType)

GetOpenGridCommand()

Returns the command for opening the grid item.

Not implemented for this controller as the AlgorithmRunStepItemsController.AlgorithmRunStepItem may not be an entity type it knows how to open. Must be implemented by an inheriting controller.

Declaration

protected override ViewCommand GetOpenGridCommand()

Returns

Type	Description
ViewCommand	The command for opening the grid item.

Overrides

LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.Client.Core.Views.Controllers.AlgorithmRunStepItemsController.AlgorithmRunStepItem>.GetOpenGridCommand()

OnOpenRowItem(AlgorithmRunStepItem)

A method called by the system to open the specified data item from the grid

The defult implementation throws an error, this must be implemented by an inheriting controller if the AllowOpenCommand is true

Declaration

public override Task OnOpenRowItem(AlgorithmRunStepItemsController.AlgorithmRunStepItem rowItem)

Parameters

Type	Name	Description
AlgorithmRunStepItemsController.AlgorithmRunStepItem	rowItem	The item to open by the system

Returns

Type	Description
Task	A task indicating the completion of the operation

Overrides

BaseGridControllerAny<AlgorithmRunStepItemsController.AlgorithmRunStepItem>.OnOpenRowItem(AlgorithmRunStepItemsController.AlgorithmRunStepItem)

RemoveItems(IEnumerable<AlgorithmRunStepItem>)

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<AlgorithmRunStepItemsController.AlgorithmRunStepItem> items)

Parameters

Type	Name	Description
IEnumerable<AlgorithmRunStepItemsController.AlgorithmRunStepItem>	items	The items to be removed from the CurrentItems

Returns

Type	Description
Task	A task indicating the completion of the operation

Overrides

BaseGridControllerAny<AlgorithmRunStepItemsController.AlgorithmRunStepItem>.RemoveItems(IEnumerable<AlgorithmRunStepItemsController.AlgorithmRunStepItem>)

Implements

IBaseGridController

ICollectionExportable

INewGridItemImplementor<T>

ICopyGridItemImplementor<T>

IGrid

IDeleteGridItemImplementor<T>

ISearchController

IModelViewController

Extension Methods

LinqExtensions.AsArray<T>(T)

LinqExtensions.ToArrayOfOne<T>(T)

LinqExtensions.ToListOfOne<T>(T)

MiscExtensions.SetIfNotEqual<T, TP>(T, Expression<Func<T, TP>>, TP)

WeakReferenceExtensions.WeakReference(object)

SQLExtensions.ToSQLValue(object, bool)

ReflectionExtensions.ClearEventInvocations(object, string)

StringExtensions.ToCSVFormatString(object, Type)