Class BaseGridAnyRelatedCollectionController<T>

The base generic grid controller which works with the IBaseGridAnyRelatedCollection<T> view and displays an entity type as rows in the grid that are all related to an other object

This is the main base controller for creating grids, and dynamically creating their columns, for any entity in the system that is related to another object. It is different from BaseGridRelatedAnyCollectionController<SI, T> or BaseGridRelatedCollectionController<SI, T> as that single item type must be the same, where as this can have a parent that can be of different types allowing it to work against any entity parent

Both this controller and the BaseDefaultSingleViewController<T> view have a similar mechanism for creating controls dynamically within the UI
Inheritance
System.Object
ModelViewController
BaseGridController
BaseGridControllerAny<T>
BaseGridController<T>
BaseGridAnyRelatedCollectionController<T>
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: LemonEdge.Client.Core.Views.Core
Assembly: ClientCore.dll
Syntax
public abstract class BaseGridAnyRelatedCollectionController<T> : BaseGridController<T>, IBaseGridController, IModelViewController, ICollectionExportable, INewGridItemImplementor<T>, ICopyGridItemImplementor<T>, IGrid, IDeleteGridItemImplementor<T> where T : IBaseEntity
Type Parameters
Name Description
T

An entity type inheriting from IBaseEntity that are all related to the SingleItem

Constructors

BaseGridAnyRelatedCollectionController(IBaseGridAnyRelatedCollection<T>)

Creates a new default grid view any related controller with the specified instance of a default grid any related view

Declaration
public BaseGridAnyRelatedCollectionController(IBaseGridAnyRelatedCollection<T> view)
Parameters
Type Name Description
IBaseGridAnyRelatedCollection<T> view

The instance of the default grid any related view in the client application

Properties

AllowIDFilter

Indicates this grids results are not filtered by any DisplayableItemDescriptorForCollectionParams, as it is not a top level collection of items

Declaration
protected override bool AllowIDFilter { get; }
Property Value
Type Description
System.Boolean
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridController<T>.AllowIDFilter

CollectionRelationshipColumnName

This is the property on the T 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 abstract string CollectionRelationshipColumnName { get; }
Property Value
Type Description
System.String

CollectionRelationshipColumnNameLabel

Holds the label column for the CollectionRelationshipColumnName

Declaration
public virtual string CollectionRelationshipColumnNameLabel { get; }
Property Value
Type Description
System.String

PopulateNewFromLookupColumnName

Returns OpenFromRelatedColumnName

Declaration
public override string PopulateNewFromLookupColumnName { get; }
Property Value
Type Description
System.String
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<T>.PopulateNewFromLookupColumnName

SingleItem

The single item this grid is being displayed against and that all entities of type T in the grid are related to

Declaration
public IBaseEntity SingleItem { get; }
Property Value
Type Description
IBaseEntity

Methods

AlterQuery(QueryableExecuter<T>)

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<T> AlterQuery(QueryableExecuter<T> query)
Parameters
Type Name Description
QueryableExecuter<T> query

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

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.BaseGridControllerAny<T>.AlterQuery(LemonEdge.Utils.QueryableExecuter<T>)

GetGridController(IBaseGridAnyRelatedCollection<T>)

Creates the new default grid related view any controller with the specified instance of a default grid any related view

Declaration
public static BaseGridAnyRelatedCollectionController<T> GetGridController(IBaseGridAnyRelatedCollection<T> view)
Parameters
Type Name Description
IBaseGridAnyRelatedCollection<T> view

The instance of the default grid any related view in the client application
Returns
Type Description
BaseGridAnyRelatedCollectionController<T>

A new default grid view any related controller with the specified instance of a default grid any related view

UpdateNewItem(T)

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(T item)
Parameters
Type Name Description
T item

The new item created for this grid
Returns
Type Description
System.Threading.Tasks.Task

A task indicating the completion of the operation
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<T>.UpdateNewItem(T)

Implements

Extension Methods