Class DefaultWatchersController

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

Constructors

DefaultWatchersController(IBaseGrid<IDefaultWatcher>)

Declaration
public DefaultWatchersController(IBaseGrid<IDefaultWatcher> view)
Parameters
Type Name Description
IBaseGrid<IDefaultWatcher> view

Properties

AllowCopyCommand

Indicates that by default selected entities can be copied by the user with the copy command

Declaration
public override bool AllowCopyCommand { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridController<LemonEdge.API.Entities.Workflow.IDefaultWatcher>.AllowCopyCommand

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.Workflow.IDefaultWatcher>.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 IDefaultWatcher 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.Workflow.IDefaultWatcher>.AutoOpenNewItemInTab

CheckIsLockedForCanWrite

Indicates the controller should check if the item is locked before allowing CanWrite to be true. Defaults to true.

Declaration
protected override bool CheckIsLockedForCanWrite { get; }
Property Value
Type Description
bool
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

Indicates when creating a new item the system should create a popup showing a selection of items from this property relationship on type IDefaultWatcher, that will automatically be set for the new item

For each relationship entity selected the system will call the callback in the GetLookupIDsForNewItems(Func<IBaseEntity, Task>) function

The default implementation is null, indicating a new item is just created as is, but can be overridden by inheriting controllers to force relationship selections first before creating items
Declaration
public override string PopulateNewFromLookupColumnName { get; }
Property Value
Type Description
string
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.Workflow.IDefaultWatcher>.PopulateNewFromLookupColumnName

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 IDefaultWatcher

Declaration
public override bool PreventDuplicateLookupIDs { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.Workflow.IDefaultWatcher>.PreventDuplicateLookupIDs

Methods

AlterQuery(QueryableExecuter<IDefaultWatcher>)

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

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

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

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

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

Implements

Extension Methods