Class CurrencyExchangeRatesController
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientEntities.dll
Syntax
public class CurrencyExchangeRatesController : BaseGridRelatedCollectionController<ICurrency, IExchangeRate>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<IExchangeRate>, ICopyGridItemImplementor<IExchangeRate>, IGrid, IDeleteGridItemImplementor<IExchangeRate>, ISearchController, IModelViewController
Constructors
CurrencyExchangeRatesController(IBaseGridRelatedCollection<ICurrency, IExchangeRate>)
Declaration
public CurrencyExchangeRatesController(IBaseGridRelatedCollection<ICurrency, IExchangeRate> view)
Parameters
Type | Name | Description |
---|---|---|
IBaseGridRelatedCollection<ICurrency, IExchangeRate> | 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 IExchangeRate 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 IExchangeRate 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
PopulateNewFromLookupColumnName
Returns OpenFromRelatedColumnName
Declaration
public override string PopulateNewFromLookupColumnName { 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 IExchangeRate
Declaration
public override bool PreventDuplicateLookupIDs { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
ViewReciprocal
Declaration
public bool ViewReciprocal { get; set; }
Property Value
Type | Description |
---|---|
bool |
Methods
AddRelationshipJoin(QueryableExecuter<IExchangeRate>)
Alters the provided query by ensuring all entities returned are related to the SingleItem by having their CollectionRelationshipColumnName have the same value as the SingleItem ID
This can be overidden to customise how the entities of type IExchangeRate are precisely related to the SingleItem if not directly through that join
Declaration
protected override QueryableExecuter<IExchangeRate> AddRelationshipJoin(QueryableExecuter<IExchangeRate> query)
Parameters
Type | Name | Description |
---|---|---|
QueryableExecuter<IExchangeRate> | query | The existing query to return all the results that will populate the grid |
Returns
Type | Description |
---|---|
QueryableExecuter<IExchangeRate> | 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
AlterQuery(QueryableExecuter<IExchangeRate>)
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 IExchangeRate are precisely related to the SingleItem if not directly through that join
Declaration
protected override QueryableExecuter<IExchangeRate> AlterQuery(QueryableExecuter<IExchangeRate> query)
Parameters
Type | Name | Description |
---|---|---|
QueryableExecuter<IExchangeRate> | query | The existing query to return all the results that will populate the grid |
Returns
Type | Description |
---|---|
QueryableExecuter<IExchangeRate> | 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
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
UpdateColumnDisplay()
Declaration
public void UpdateColumnDisplay()
UpdateNewItem(IExchangeRate)
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(IExchangeRate item)
Parameters
Type | Name | Description |
---|---|---|
IExchangeRate | item | The new item created for this grid |
Returns
Type | Description |
---|---|
Task | A task indicating the completion of the operation |