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

Constructors

FolderDocumentsController(IBaseGridRelatedCollection<IFolder, IDocument>)

Declaration

public FolderDocumentsController(IBaseGridRelatedCollection<IFolder, IDocument> view)

Parameters

Type	Name	Description
IBaseGridRelatedCollection<IFolder, IDocument>	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.Workflow.IDocument>.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 IDocument 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.Workflow.IDocument>.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.Workflow.IDocument>.AutoSelectFirstRow

CanBePrivate

Declaration

public bool CanBePrivate { get; }

Property Value

Type	Description
bool

CollectionRelationshipColumnName

This is the property on the IDocument 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.Workflow.IDocument>.CollectionRelationshipColumnName

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 IDocument

Declaration

protected override INewItemHelper<IDocument> NewItemHelper { get; }

Property Value

Type	Description
INewItemHelper<IDocument>

Overrides

LemonEdge.Client.Core.Views.Core.BaseGridController<LemonEdge.API.Entities.Workflow.IDocument>.NewItemHelper

ViewAllFolders

Declaration

public bool ViewAllFolders { get; set; }

Property Value

Type	Description
bool

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.Workflow.IDocument>.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.Workflow.IDocument>.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)

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<IDocument>> GetGridSourceItems()

Returns

Type	Description
Task<IEnumerable<IDocument>>	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.Workflow.IDocument>.GetGridSourceItems()

GetOpenGridCommand()

Provdies the open command required to open any entity in the system

Declaration

protected override ViewCommand GetOpenGridCommand()

Returns

Type	Description
ViewCommand	The OpenGridItem<T> command

Overrides

LemonEdge.Client.Core.Views.Core.BaseGridController<LemonEdge.API.Entities.Workflow.IDocument>.GetOpenGridCommand()

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(IDocument)

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(IDocument rowItem)

Parameters

Type	Name	Description
IDocument	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.Workflow.IDocument>.OnOpenRowItem(LemonEdge.API.Entities.Workflow.IDocument)

UpdateNewItem(IDocument)

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

Parameters

Type	Name	Description
IDocument	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.Workflow.IDocument>.UpdateNewItem(LemonEdge.API.Entities.Workflow.IDocument)