Class ChartsController

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

Constructors

ChartsController(IBaseGrid<IChart>)

Declaration
public ChartsController(IBaseGrid<IChart> view)
Parameters
Type Name Description
IBaseGrid<IChart> 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.IChart>.AllowOpenCommand

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 IChart is an entity that is not a IsStandingDataEntity

Declaration
public override bool AutoOpenNewItemInTab { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.Reporting.IChart>.AutoOpenNewItemInTab

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<IChart>)

Provides the inheriting controller an opportunity to modify the query used to load the data for this IBaseGrid<T>

Default implementation does nothing unless the type IChart is an entity with a property with a SequenceStart, in which case it is ordered by that

Declaration
protected override QueryableExecuter<IChart> AlterQuery(QueryableExecuter<IChart> query)
Parameters
Type Name Description
QueryableExecuter<IChart> query

The query for this grid to always be altered before being executed
Returns
Type Description
QueryableExecuter<IChart>

The query to be used to execute results for this grid
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.Reporting.IChart>.AlterQuery(LemonEdge.Utils.QueryableExecuter<LemonEdge.API.Entities.Reporting.IChart>)

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.IChart>.ColumnNames()

UpdateNewItem(IChart)

Provides an inheriting controller an opportunity to alter the newly created item by the grid before it is added to the IBaseGrid<T> itself

By default this ensures the item has the next maximum sequence number if the item is an entity that has a property with a SequenceStart

Declaration
protected override Task UpdateNewItem(IChart item)
Parameters
Type Name Description
IChart item

The newly created item to be added to the grid
Returns
Type Description
Task

A task indicating the completion of the operation
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.Reporting.IChart>.UpdateNewItem(LemonEdge.API.Entities.Reporting.IChart)

Implements

Extension Methods