Class BaseEntitySetEntitiesController<ES, SE>
An optional grid controller that displays a grid of ISetEntity (
SE) that are members of a single IEntitySetBase (ES)
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientCore.dll
Syntax
public abstract class BaseEntitySetEntitiesController<ES, SE> : BaseGridRelatedCollectionController<ES, SE>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<SE>, ICopyGridItemImplementor<SE>, IGrid, IDeleteGridItemImplementor<SE>, ISearchController, IModelViewController where ES : IEntitySetBase where SE : ISetEntityType Parameters
| Name | Description |
|---|---|
| ES | The entity set base that inherits from IEntitySetBase and has an associated set of ISetEntity |
| SE | The set entities displayed as a grid |
Constructors
BaseEntitySetEntitiesController(IBaseGridRelatedCollection<ES, SE>)
Creates a new BaseEntitiesSetEntityController
Declaration
public BaseEntitySetEntitiesController(IBaseGridRelatedCollection<ES, SE> view)Parameters
| Type | Name | Description |
|---|---|---|
| IBaseGridRelatedCollection<ES, SE> | view | The IBaseGridRelatedCollection view implementation using the UI components of the client application |
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
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 SE is an entity that is not a IsStandingDataEntity
Declaration
public override bool AutoOpenNewItemInTab { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
CollectionRelationshipColumnName
This is the property on the SE 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<TCollection>)
Declaration
public override string CollectionRelationshipColumnName { get; }Property Value
| Type | Description |
|---|---|
| string |
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
IncludeOwningEntityID
Declaration
protected virtual bool IncludeOwningEntityID { get; }Property Value
| Type | Description |
|---|---|
| bool |
OpenFromRelatedColumnName
Indicates when opening a selected item in the grid, that it should not open the item itself, but rather the item referred to by the value held against this property on the type
The default value is null, indicating it should just open the item itself, but can be overridden by a derived controller to open other related items by default
Declaration
public override string OpenFromRelatedColumnName { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
Methods
AlterColumnInfo(ControlDisplayInfo)
Declaration
protected override void AlterColumnInfo(ControlDisplayInfo info)Parameters
| Type | Name | Description |
|---|---|---|
| ControlDisplayInfo | info | The controls to optional alter the display of before the view builds the column for it |
Overrides
AlterQuery(QueryableExecuter<SE>)
Orders the list of ISetEntity by the EntityID label
Declaration
protected override QueryableExecuter<SE> AlterQuery(QueryableExecuter<SE> query)Parameters
| Type | Name | Description |
|---|---|---|
| QueryableExecuter<SE> | query | The query to modify |
Returns
| Type | Description |
|---|---|
| QueryableExecuter<SE> | The query to load all records for this grid |
Overrides
ColumnNames()
Adds the EntitySetID (hidden), and EntityID as columns to the grid
Declaration
protected override IEnumerable<ControlDisplayInfoLight> ColumnNames()Returns
| Type | Description |
|---|---|
| IEnumerable<ControlDisplayInfoLight> | THe columns to be displayed in this grid |
Overrides
GetValidOwningEntityIDs()
Declaration
protected virtual Task<Guid[]> GetValidOwningEntityIDs()Returns
| Type | Description |
|---|---|
| Task<Guid[]> |
InitCommands(IList<ViewCommand>)
Adds the following commands, if the associated AllowXXXCommand property returns true: A public toggle, multi-select row, open, column visiblitiy, transfer visible, search, view cancelled, view system, export, new, copy, move up/down, xml export, and delete commands
Declaration
protected override void InitCommands(IList<ViewCommand> commands)Parameters
| Type | Name | Description |
|---|---|---|
| IList<ViewCommand> | commands | The initial set of commands for this view |