Class AllDocumentsController

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

Constructors

AllDocumentsController(IBaseGrid<IDocument>)

Declaration
public AllDocumentsController(IBaseGrid<IDocument> view)
Parameters
Type Name Description
IBaseGrid<IDocument> view

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
LemonEdge.Client.Core.Views.Core.BaseGridController<LemonEdge.API.Entities.Workflow.IDocument>.AllowCopyCommand

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

CheckIsLockedForCanWrite

Indicates the controller should check if the item is locked before allowing CanWrite to be true. Defaults to true.

Declaration
protected override bool CheckIsLockedForCanWrite { get; }
Property Value
Type Description
bool
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

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 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

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

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)

OpenItem(IDocument)

Declaration
public Task OpenItem(IDocument selected)
Parameters
Type Name Description
IDocument selected
Returns
Type Description
Task

OpenItem(BaseGridController<IDocument>, IDocument)

Declaration
public static Task OpenItem(BaseGridController<IDocument> controller, IDocument selected)
Parameters
Type Name Description
BaseGridController<IDocument> controller
IDocument selected
Returns
Type Description
Task

Implements

Extension Methods