Class SwitchCanvas
This command executes the SwitchCanvas system command
Lists all canvases the user has access to, and the main system (no canvas), as child commands.
Executing any will switch the users context to that canvas, or main system, and perform a RefreshAll to run the system in that new canvasInheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Commands
Assembly: LemonEdge.ClientCore.dll
Syntax
[CommandDescriptorOptions(Command.SwitchCanvas, null)]
public class SwitchCanvas : EPCommandWithDescriptor, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IDisposable, IEPCommandWithDescriptor, IEPCommand, ICommand, ICommandDescriptorConstructors
SwitchCanvas(IRootController, IModelLayoutCommon)
Creates a new SwitchCanvas command which will have all canvases, and the main system, as child commands
Declaration
public SwitchCanvas(IRootController root, IModelLayoutCommon owner)Parameters
| Type | Name | Description |
|---|---|---|
| IRootController | root | The root controller, for service access. |
| IModelLayoutCommon | owner | The owning context for this command |
SwitchCanvas(IRootController, IModelLayoutCommon, ICanvas)
Creates a new SwitchCanvas that will switch the system into running under the specified canvas
Declaration
protected SwitchCanvas(IRootController root, IModelLayoutCommon owner, ICanvas canvas)Parameters
| Type | Name | Description |
|---|---|---|
| IRootController | root | The root controller, for service access. |
| IModelLayoutCommon | owner | The owning context for this command |
| ICanvas | canvas | The canvas the system will switch to running under |
SwitchCanvas(IRootController, IModelLayoutCommon, bool)
Creates a new SwitchCanvas command which will switch the system into the main system - no canvas
Declaration
protected SwitchCanvas(IRootController root, IModelLayoutCommon owner, bool reset)Parameters
| Type | Name | Description |
|---|---|---|
| IRootController | root | The root controller, for service access. |
| IModelLayoutCommon | owner | The owning context for this command |
| bool | reset | Indicates to switch into the main system |
Properties
Description
A user friendly description of this command
Declaration
public override string Description { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
HasChildCommands
True if this is the root command that lists all accessible canvases and the main system
Declaration
public override bool HasChildCommands { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
IconID
Declaration
public override Guid IconID { get; }Property Value
| Type | Description |
|---|---|
| Guid |
Overrides
Title
The title of this command
Declaration
public override string Title { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
Methods
InternalCanExecute(object)
True if the owning host is the main form application instance
Declaration
public override bool InternalCanExecute(object parameter)Parameters
| Type | Name | Description |
|---|---|---|
| object | parameter | The command parameter |
Returns
| Type | Description |
|---|---|
| bool | True if the owning host is the main form application instance |
Overrides
InternalExecuteAsync(object)
Switches running the system into the specified canvas, or main system (no canvas), for this command
Declaration
public override Task InternalExecuteAsync(object parameter)Parameters
| Type | Name | Description |
|---|---|---|
| object | parameter | The command parameter |
Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of this operation |
Overrides
LoadChildrenAsync()
Loads all the canvases this user has access to run in, along with the main system
Declaration
public override Task LoadChildrenAsync()Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operation |
Overrides
Switch(IModelLayoutCommon, ICanvas, bool)
Switch the users context to the specified canvas, or main system, and perform a RefreshAll to run the system in that new canvas
Declaration
public static Task Switch(IModelLayoutCommon owner, ICanvas canvas, bool reset)Parameters
| Type | Name | Description |
|---|---|---|
| IModelLayoutCommon | owner | The owning host this command runs within |
| ICanvas | canvas | The canvas to switch running the system into. Can be null if switching to the main system. |
| bool | reset | If true then will switch the system into running under the main system - no canvas |
Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operation |