Class VennSetQueryableItemsController

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

Constructors

VennSetQueryableItemsController(IBaseGridRelatedCollection<IVennSet, IVennSetQueryableItem>, IQueryableTypeFactory)

Declaration
public VennSetQueryableItemsController(IBaseGridRelatedCollection<IVennSet, IVennSetQueryableItem> view, IQueryableTypeFactory queryableTypeFactory)
Parameters
Type Name Description
IBaseGridRelatedCollection<IVennSet, IVennSetQueryableItem> view
IQueryableTypeFactory queryableTypeFactory

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.Reporting.IVennSetQueryableItem>.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 IVennSetQueryableItem 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.Reporting.IVennSetQueryableItem>.AutoOpenNewItemInTab

AutoSelectFirstRow

Indicates the first row of the results in this grid should automatically be selected by the view when the data is loaded and displayed

The default is false

Declaration
protected override bool AutoSelectFirstRow { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.Reporting.IVennSetQueryableItem>.AutoSelectFirstRow

CollectionRelationshipColumnName

This is the property on the IVennSetQueryableItem 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
LemonEdge.Client.Core.Views.Core.BaseGridRelatedCollectionController<LemonEdge.API.Entities.Reporting.IVennSet, LemonEdge.API.Entities.Reporting.IVennSetQueryableItem>.CollectionRelationshipColumnName

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

NewItemHelper

Returns a standard NewItemDescriptor<T> for the entity type IVennSetQueryableItem

Declaration
protected override INewItemHelper<IVennSetQueryableItem> NewItemHelper { get; }
Property Value
Type Description
INewItemHelper<IVennSetQueryableItem>
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridController<LemonEdge.API.Entities.Reporting.IVennSetQueryableItem>.NewItemHelper

Methods

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.Reporting.IVennSetQueryableItem>.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.Reporting.IVennSetQueryableItem>.DisplayUI()

GetGridSourceItems()

Executes the query (GetCurrentQuery()) for the entities required in this grid, sets the total count (as it is different due to paging), and returns the results

Declaration
public override Task<IEnumerable<IVennSetQueryableItem>> GetGridSourceItems()
Returns
Type Description
Task<IEnumerable<IVennSetQueryableItem>>

The result of executing the GetCurrentQuery() to return all the entities that should be displayed in this grid
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridController<LemonEdge.API.Entities.Reporting.IVennSetQueryableItem>.GetGridSourceItems()

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
Overrides

OnOpenRowItem(IVennSetQueryableItem)

Opens the specified entity item in a new IModelLayoutDisplayer.

Either opens the item itself, or a related item if OpenFromRelatedColumnName is populated

Declaration
public override Task OnOpenRowItem(IVennSetQueryableItem rowItem)
Parameters
Type Name Description
IVennSetQueryableItem rowItem

The specified item to open in a new IModelLayoutDisplayer
Returns
Type Description
Task

A task indicating the completion of the operation
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridController<LemonEdge.API.Entities.Reporting.IVennSetQueryableItem>.OnOpenRowItem(LemonEdge.API.Entities.Reporting.IVennSetQueryableItem)

RemoveItems(IEnumerable<IVennSetQueryableItem>)

Removes the specified set of items from the grid and if the items in the grid have a property marked as SequenceStart then it will decrement the ones above these deleted items to reflect their change in order

Declaration
public override Task RemoveItems(IEnumerable<IVennSetQueryableItem> items)
Parameters
Type Name Description
IEnumerable<IVennSetQueryableItem> items

The items to be removed from the CurrentItems
Returns
Type Description
Task

A task indicating the completion of the operation
Overrides

Implements

Extension Methods