Class EntityDescriptorsController

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

Constructors

EntityDescriptorsController(IBaseGrid<EntityDescriptor>)

Declaration
public EntityDescriptorsController(IBaseGrid<EntityDescriptor> view)
Parameters
Type Name Description
IBaseGrid<EntityDescriptor> view

Properties

AllowDeleteCommand

Indicates the command to allow selected rows to be deleted by the user is included in the InitCommands(IList<ViewCommand>)

The default is false

Declaration
public override bool AllowDeleteCommand { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Descriptors.EntityDescriptor>.AllowDeleteCommand

AllowNewCommand

Indicates the command to allow new items to be created by the user is included in the InitCommands(IList<ViewCommand>)

The default is false if NewItemHelper is equal to null

Declaration
public override bool AllowNewCommand { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Descriptors.EntityDescriptor>.AllowNewCommand

AllowOpenCommand

Indicates the command to allow selected rows to be opened by the user is included in the InitCommands(IList<ViewCommand>)

The default is false

Declaration
public override bool AllowOpenCommand { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Descriptors.EntityDescriptor>.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 EntityDescriptor 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.Descriptors.EntityDescriptor>.AutoOpenNewItemInTab

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

OnlyExportGrid

Indicates when performing a stadard data export that the data should only be exported from the grid itself, and not re-run any query

The default is false

Declaration
public override bool OnlyExportGrid { get; }
Property Value
Type Description
bool
Overrides

Methods

AlterQuery(QueryableExecuter<EntityDescriptor>)

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 EntityDescriptor is an entity with a property with a SequenceStart, in which case it is ordered by that

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

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

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

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

GetGridSourceItems()

A function that must be implemented by inheriting classes that returns the list of items to be displayed against the grid given all active filters, sorting, searches, paging, etc

Declaration
public override Task<IEnumerable<EntityDescriptor>> GetGridSourceItems()
Returns
Type Description
Task<IEnumerable<EntityDescriptor>>

A list of items to be displayed against the grid given all active filters, sorting, searches, paging, etc
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Descriptors.EntityDescriptor>.GetGridSourceItems()

Implements

Extension Methods