Class PermissionsController

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

Constructors

PermissionsController(IBaseGridAnyRelatedCollection<IPermission>)

Declaration
public PermissionsController(IBaseGridAnyRelatedCollection<IPermission> view)
Parameters
Type Name Description
IBaseGridAnyRelatedCollection<IPermission> 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.Administration.IPermission>.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.Administration.IPermission>.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 IPermission 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.Administration.IPermission>.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

CollectionRelationshipColumnName

This is the property on the IPermission 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<T>)

Declaration
public override string CollectionRelationshipColumnName { get; }
Property Value
Type Description
string
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridAnyRelatedCollectionController<LemonEdge.API.Entities.Administration.IPermission>.CollectionRelationshipColumnName

CollectionRelationshipColumnNameLabel

Holds the label column for the CollectionRelationshipColumnName

Declaration
public override string CollectionRelationshipColumnNameLabel { get; }
Property Value
Type Description
string
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridAnyRelatedCollectionController<LemonEdge.API.Entities.Administration.IPermission>.CollectionRelationshipColumnNameLabel

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

Returns OpenFromRelatedColumnName

Declaration
public override string PopulateNewFromLookupColumnName { get; }
Property Value
Type Description
string
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridAnyRelatedCollectionController<LemonEdge.API.Entities.Administration.IPermission>.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 IPermission

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

Methods

AlterQuery(QueryableExecuter<IPermission>)

Additionally alters the base query alteration by ensuring all entities returned are related to the SingleItem by having their CollectionRelationshipColumnName have the same value as the SingleItem ID

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

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

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.BaseGridAnyRelatedCollectionController<LemonEdge.API.Entities.Administration.IPermission>.AlterQuery(LemonEdge.Utils.QueryableExecuter<LemonEdge.API.Entities.Administration.IPermission>)

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

DisplayUI()

Initializes the grid, and creates every ControlDisplayInfo in the defined Columns() and creates them on the grid

Then loads the data for the grid accounting for all view sorting, filtering, searching and paging, and loads the results into the grid as an observable collection

Declaration
public override Task DisplayUI()
Returns
Type Description
Task

A task indicating the completion of the operation
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.Administration.IPermission>.DisplayUI()

GetInternalDescriptor()

Returns the descriptor for the entity type IPermission

Declaration
protected override EntityDescriptor GetInternalDescriptor()
Returns
Type Description
EntityDescriptor

The descriptor for the entity type IPermission
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridController<LemonEdge.API.Entities.Administration.IPermission>.GetInternalDescriptor()

ShouldDisplayItem(object)

Indicates if this item should be displayed against this view

By default this returns true if the item is not null or DisplayIfNull is true

Declaration
protected override bool ShouldDisplayItem(object item)
Parameters
Type Name Description
object item

The item to check if it should be displayed against the View
Returns
Type Description
bool

True if this item should be displayed against this view
Overrides

UpdateNewItem(IPermission)

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(IPermission item)
Parameters
Type Name Description
IPermission 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.BaseGridAnyRelatedCollectionController<LemonEdge.API.Entities.Administration.IPermission>.UpdateNewItem(LemonEdge.API.Entities.Administration.IPermission)

Implements

Extension Methods