Class DatasetDataTemplatesController

Inheritance
object
ModelViewController
BaseGridController
BaseGridControllerAny<IDataTemplate>
BaseGridController<IDataTemplate>
BaseGridRelatedCollectionController<IDataset, IDataTemplate>
DatasetDataTemplatesController
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientEntities.dll
Syntax
public class DatasetDataTemplatesController : BaseGridRelatedCollectionController<IDataset, IDataTemplate>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<IDataTemplate>, ICopyGridItemImplementor<IDataTemplate>, IGrid, IDeleteGridItemImplementor<IDataTemplate>, ISearchController, IModelViewController

Constructors

DatasetDataTemplatesController(IBaseGridRelatedCollection<IDataset, IDataTemplate>)

Declaration
public DatasetDataTemplatesController(IBaseGridRelatedCollection<IDataset, IDataTemplate> view)
Parameters
Type Name Description
IBaseGridRelatedCollection<IDataset, IDataTemplate> 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
LemonEdge.Client.Core.Views.Core.BaseGridController<LemonEdge.API.Entities.Reporting.IDataTemplate>.AllowOpenCommand

CollectionRelationshipColumnName

This is the property on the IDataTemplate 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.BaseGridRelatedCollectionController<LemonEdge.API.Entities.Reporting.IDataset, LemonEdge.API.Entities.Reporting.IDataTemplate>.CollectionRelationshipColumnName

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

Methods

AddRelationshipJoin(QueryableExecuter<IDataTemplate>)

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 IDataTemplate are precisely related to the SingleItem if not directly through that join

Declaration
protected override QueryableExecuter<IDataTemplate> AddRelationshipJoin(QueryableExecuter<IDataTemplate> query)
Parameters
Type Name Description
QueryableExecuter<IDataTemplate> query

The existing query to return all the results that will populate the grid
Returns
Type Description
QueryableExecuter<IDataTemplate>

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
LemonEdge.Client.Core.Views.Core.BaseGridRelatedCollectionController<LemonEdge.API.Entities.Reporting.IDataset, LemonEdge.API.Entities.Reporting.IDataTemplate>.AddRelationshipJoin(LemonEdge.Utils.QueryableExecuter<LemonEdge.API.Entities.Reporting.IDataTemplate>)

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.API.Entities.Reporting.IDataTemplate>.ColumnNames()

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

UpdateNewItem(IDataTemplate)

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(IDataTemplate item)
Parameters
Type Name Description
IDataTemplate item

The new item created for this grid
Returns
Type Description
Task

A task indicating the completion of the operation
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridRelatedCollectionController<LemonEdge.API.Entities.Reporting.IDataset, LemonEdge.API.Entities.Reporting.IDataTemplate>.UpdateNewItem(LemonEdge.API.Entities.Reporting.IDataTemplate)

Implements

Extension Methods