Class CustomCommandsController

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

Constructors

CustomCommandsController(IBaseGrid<ICustomCommand>)

Declaration
public CustomCommandsController(IBaseGrid<ICustomCommand> view)
Parameters
Type Name Description
IBaseGrid<ICustomCommand> 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.Design.ICustomCommand>.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.Design.ICustomCommand>.AllowOpenCommand

AllowXMLImportExport

Indicates the command to allow the xml export of the data by the user is included in the InitCommands(IList<ViewCommand>)

The default is true if the type ICustomCommand derives from ISetCopier

Declaration
public override bool AllowXMLImportExport { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.Design.ICustomCommand>.AllowXMLImportExport

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 ICustomCommand 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.Design.ICustomCommand>.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

Methods

AlterColumnInfo(ControlDisplayInfo)

Provides an inheriting controller the opportunity to alter the specified column before it is added to the IBaseGrid<T>

This is used in conjunction with columns defined via ColumnNames(), rather than Columns() which explicitly defines all information

The default operation provides a CustomComboItems if the column is against a property that is a link to an entity type (IsEntityLink)
Declaration
protected override void AlterColumnInfo(ControlDisplayInfo info)
Parameters
Type Name Description
ControlDisplayInfo info

The definition of the column that can be updated before being created in the IBaseGrid<T>
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.Design.ICustomCommand>.AlterColumnInfo(LemonEdge.Client.UI.API.Controls.ControlDisplayInfo)

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.Design.ICustomCommand>.ColumnNames()

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

Implements

Extension Methods