Class InstrumentSetItemsController
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientEntities.dll
Syntax
public class InstrumentSetItemsController : BaseGridRelatedCollectionController<IInstrumentSet, IInstrumentSetItem>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<IInstrumentSetItem>, ICopyGridItemImplementor<IInstrumentSetItem>, IGrid, IDeleteGridItemImplementor<IInstrumentSetItem>, ISearchController, IModelViewControllerConstructors
InstrumentSetItemsController(IBaseGridRelatedCollection<IInstrumentSet, IInstrumentSetItem>)
Declaration
public InstrumentSetItemsController(IBaseGridRelatedCollection<IInstrumentSet, IInstrumentSetItem> view)Parameters
| Type | Name | Description |
|---|---|---|
| IBaseGridRelatedCollection<IInstrumentSet, IInstrumentSetItem> | 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 IInstrumentSetItem 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 IInstrumentSetItem 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
AlterQuery(QueryableExecuter<IInstrumentSetItem>)
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 IInstrumentSetItem are precisely related to the SingleItem if not directly through that join
Declaration
protected override QueryableExecuter<IInstrumentSetItem> AlterQuery(QueryableExecuter<IInstrumentSetItem> query)Parameters
| Type | Name | Description |
|---|---|---|
| QueryableExecuter<IInstrumentSetItem> | query | The existing query to return all the results that will populate the grid |
Returns
| Type | Description |
|---|---|
| QueryableExecuter<IInstrumentSetItem> | 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> |