Class CanvasesController
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientEntities.dll
Syntax
public class CanvasesController : BaseGridController<ICanvas>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<ICanvas>, ICopyGridItemImplementor<ICanvas>, IGrid, IDeleteGridItemImplementor<ICanvas>, ISearchController, IModelViewControllerConstructors
CanvasesController(IBaseGrid<ICanvas>)
Declaration
public CanvasesController(IBaseGrid<ICanvas> view)Parameters
| Type | Name | Description |
|---|---|---|
| IBaseGrid<ICanvas> | 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
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
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 ICanvas is an entity that is not a IsStandingDataEntity
Declaration
public override bool AutoOpenNewItemInTab { 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 ICanvas
Declaration
protected override INewItemHelper<ICanvas> NewItemHelper { get; }Property Value
| Type | Description |
|---|---|
| INewItemHelper<ICanvas> |
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
AlterQuery(QueryableExecuter<ICanvas>)
Provides the inheriting controller an opportunity to modify the query used to load the data for this IBaseGrid<T>
Default implementation does nothing unless the type ICanvas is an entity with a property with a SequenceStart, in which case it is ordered by that
Declaration
protected override QueryableExecuter<ICanvas> AlterQuery(QueryableExecuter<ICanvas> query)Parameters
| Type | Name | Description |
|---|---|---|
| QueryableExecuter<ICanvas> | query | The query for this grid to always be altered before being executed |
Returns
| Type | Description |
|---|---|
| QueryableExecuter<ICanvas> | The query to be used to execute results for this grid |
Overrides
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 thisDeclaration
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
GetDeleteCommand()
Returns the command for deleting an item in the grid
Declaration
protected override ViewCommand GetDeleteCommand()Returns
| Type | Description |
|---|---|
| ViewCommand | The command for deleting an item in the grid |
Overrides
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
UpdateNewItem(ICanvas)
Provides an inheriting controller an opportunity to alter the newly created item by the grid before it is added to the IBaseGrid<T> itself
By default this ensures the item has the next maximum sequence number if the item is an entity that has a property with a SequenceStart
Declaration
protected override Task UpdateNewItem(ICanvas item)Parameters
| Type | Name | Description |
|---|---|---|
| ICanvas | item | The newly created item to be added to the grid |
Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operation |