Class CustomGridsController

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

Constructors

CustomGridsController(IBaseGrid<ICustomGrid>)

Declaration
public CustomGridsController(IBaseGrid<ICustomGrid> view)
Parameters
Type Name Description
IBaseGrid<ICustomGrid> 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.Design.ICustomGrid>.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 ICustomGrid 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.Design.ICustomGrid>.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

AlterColumnInfo(ControlDisplayInfo)

Provides an inheriting controller the opportunity to alter the specified column before it is added to the IBaseGrid<T>

This is used in conjunction with columns defined via ColumnNames(), rather than Columns() which explicitly defines all information

The default operation provides a CustomComboItems if the column is against a property that is a link to an entity type (IsEntityLink)
Declaration
protected override void AlterColumnInfo(ControlDisplayInfo info)
Parameters
Type Name Description
ControlDisplayInfo info

The definition of the column that can be updated before being created in the IBaseGrid<T>
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.Design.ICustomGrid>.AlterColumnInfo(LemonEdge.Client.UI.API.Controls.ControlDisplayInfo)

AlterLoadedItems(IEnumerable<ICustomGrid>)

Provides a mechanism for an inhetiring class to alter all the loaded items before they are sent to the GridView to be displayed

Declaration
protected override Task<IEnumerable<ICustomGrid>> AlterLoadedItems(IEnumerable<ICustomGrid> items)
Parameters
Type Name Description
IEnumerable<ICustomGrid> items

The items loaded for display into the GridView
Returns
Type Description
Task<IEnumerable<ICustomGrid>>
Overrides

AlterQuery(QueryableExecuter<ICustomGrid>)

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

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

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

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

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

GetTypePropertiesComboItems(ICustomGrid)

Declaration
public KeyValuePair<string, string>[] GetTypePropertiesComboItems(ICustomGrid item)
Parameters
Type Name Description
ICustomGrid item
Returns
Type Description
KeyValuePair<string, string>[]

UpdateNewItem(ICustomGrid)

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(ICustomGrid newItem)
Parameters
Type Name Description
ICustomGrid newItem
Returns
Type Description
Task

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

Implements

Extension Methods