Class BlendTransactionInstrumentsController
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientEntities.dll
Syntax
public class BlendTransactionInstrumentsController : BaseGridRelatedCollectionController<IBlendTransaction, IBlendTransactionInstrumentSet>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<IBlendTransactionInstrumentSet>, ICopyGridItemImplementor<IBlendTransactionInstrumentSet>, IGrid, IDeleteGridItemImplementor<IBlendTransactionInstrumentSet>, ISearchController, IModelViewControllerConstructors
BlendTransactionInstrumentsController(IBaseGridRelatedCollection<IBlendTransaction, IBlendTransactionInstrumentSet>)
Declaration
public BlendTransactionInstrumentsController(IBaseGridRelatedCollection<IBlendTransaction, IBlendTransactionInstrumentSet> view)Parameters
| Type | Name | Description |
|---|---|---|
| IBaseGridRelatedCollection<IBlendTransaction, IBlendTransactionInstrumentSet> | 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
CollectionRelationshipColumnName
This is the property on the IBlendTransactionInstrumentSet 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
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
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
AlterQuery(QueryableExecuter<IBlendTransactionInstrumentSet>)
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 IBlendTransactionInstrumentSet are precisely related to the SingleItem if not directly through that join
Declaration
protected override QueryableExecuter<IBlendTransactionInstrumentSet> AlterQuery(QueryableExecuter<IBlendTransactionInstrumentSet> query)Parameters
| Type | Name | Description |
|---|---|---|
| QueryableExecuter<IBlendTransactionInstrumentSet> | query | The existing query to return all the results that will populate the grid |
Returns
| Type | Description |
|---|---|
| QueryableExecuter<IBlendTransactionInstrumentSet> | 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
InitCommands(IList<ViewCommand>)
Adds the following commands, if the associated AllowXXXCommand property returns true: A public toggle, multi-select row, open, column visiblitiy, transfer visible, search, view cancelled, view system, export, new, copy, move up/down, xml export, and delete commands
Declaration
protected override void InitCommands(IList<ViewCommand> commands)Parameters
| Type | Name | Description |
|---|---|---|
| IList<ViewCommand> | commands | The initial set of commands for this view |
Overrides
OnTrackedItemChanged(object, string)
Provids a mechanism for handling changes for any item in the context
By default this is used to apply changes made to a selected item automatically to all other selected items in the grid (if multi-select is enabled)
Declaration
protected override void OnTrackedItemChanged(object item, string propName)Parameters
| Type | Name | Description |
|---|---|---|
| object | item | The item that changed |
| string | propName | The property name of the changed value |
Overrides
UpdateNewItem(IBlendTransactionInstrumentSet)
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(IBlendTransactionInstrumentSet item)Parameters
| Type | Name | Description |
|---|---|---|
| IBlendTransactionInstrumentSet | item | The new item created for this grid |
Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operation |