public class FolderReportsController : BaseGridRelatedCollectionController<IFolder, IReport>, ICollectionExportable, INewGridItemImplementor<IReport>, ICopyGridItemImplementor<IReport>, IDeleteGridItemImplementor<IReport>, ISearchController, IFolderItemsController, IBaseGridController, IGrid, IModelViewController

Constructors

FolderReportsController(IBaseGridRelatedCollection<IFolder, IReport>)

Declaration

public FolderReportsController(IBaseGridRelatedCollection<IFolder, IReport> view)

Parameters

Type	Name	Description
IBaseGridRelatedCollection<IFolder, IReport>	view

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.IReport>.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 IReport 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.IReport>.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.IReport>.AutoSelectFirstRow

CollectionRelationshipColumnName

This is the property on the IReport 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.Data.IFolder, LemonEdge.API.Entities.Reporting.IReport>.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

ModelViewController.ContextHelpURL

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

BaseGridController.DefaultSearchColumn

DisplayIfNull

Indicates that even if the item is null the view should still update and display a null value. Default value is false.

Declaration

public override bool DisplayIfNull { get; }

Property Value

Type	Description
bool

Overrides

ModelViewController.DisplayIfNull

NewItemHelper

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

Declaration

protected override INewItemHelper<IReport> NewItemHelper { get; }

Property Value

Type	Description
INewItemHelper<IReport>

Overrides

LemonEdge.Client.Core.Views.Core.BaseGridController<LemonEdge.API.Entities.Reporting.IReport>.NewItemHelper

ViewAllFolders

Declaration

public bool ViewAllFolders { get; set; }

Property Value

Type	Description
bool

Methods

AlterQuery(QueryableExecuter<IReport>)

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

This is achieved via AddRelationshipJoin(QueryableExecuter<TCollection>) which can be overidden to customise how the entities of type IReport are precisely related to the SingleItem if not directly through that join

Declaration

protected override QueryableExecuter<IReport> AlterQuery(QueryableExecuter<IReport> query)

Parameters

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

Returns

Type	Description
QueryableExecuter<IReport>	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.BaseGridRelatedCollectionController<LemonEdge.API.Entities.Data.IFolder, LemonEdge.API.Entities.Reporting.IReport>.AlterQuery(LemonEdge.Utils.QueryableExecuter<LemonEdge.API.Entities.Reporting.IReport>)

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

GetCanWrite(object)

Declaration

protected override Task<bool> GetCanWrite(object item)

Parameters

Type	Name	Description
object	item

Returns

Type	Description
Task<bool>

Overrides

ModelViewController.GetCanWrite(object)

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

OnTrackedItemChanged(object, string)

Provids a mechanism for handling changes for any item in the context

By default this is used to apply changes made to a selected item automatically to all other selected items in the grid (if multi-select is enabled)

Declaration

protected override void OnTrackedItemChanged(object item, string propName)

Parameters

Type	Name	Description
object	item	The item that changed
string	propName	The property name of the changed value

Overrides

BaseGridControllerAny<IReport>.OnTrackedItemChanged(object, string)

UpdateNewItem(IReport)

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(IReport item)

Parameters

Type	Name	Description
IReport	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.BaseGridRelatedCollectionController<LemonEdge.API.Entities.Data.IFolder, LemonEdge.API.Entities.Reporting.IReport>.UpdateNewItem(LemonEdge.API.Entities.Reporting.IReport)