Class Close
This command executes the Close system command
Closes the current active layout
Inherited Members
Namespace: LemonEdge.Client.Core.Commands
Assembly: LemonEdge.ClientCore.dll
Syntax
[CommandDescriptorOptions(Command.Close, null)]
public class Close : EPCommand, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IEPCommand, ICommand, IDisposable
Constructors
Close(IRootController, IModelLayoutCommon)
Creates a new Close command
Declaration
public Close(IRootController root, IModelLayoutCommon owner)
Parameters
Type | Name | Description |
---|---|---|
IRootController | root | The root controller, for service access. |
IModelLayoutCommon | owner | The owning context for this command |
Properties
Key
Indicates the command key to use for executing this from a keyboard command
Declaration
public override KeyboardKey Key { get; }
Property Value
Type | Description |
---|---|
KeyboardKey |
Overrides
ModifierKeys
Indicates the modifier keys to be used with Key when executing this command from the keyboard
Declaration
public override KeyboardModifierKeys ModifierKeys { get; }
Property Value
Type | Description |
---|---|
KeyboardModifierKeys |
Overrides
SubscribeToLayoutChange
Returns true indicating this command should respond to the current selected layout changing
Declaration
protected override bool SubscribeToLayoutChange { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
Methods
CloseLayout(IModelLayoutDisplayer)
Declaration
public static Task CloseLayout(IModelLayoutDisplayer layout)
Parameters
Type | Name | Description |
---|---|---|
IModelLayoutDisplayer | layout |
Returns
Type | Description |
---|---|
Task |
InternalCanExecute(object)
Returns true if there is a current active layout displayed to the user
Declaration
public override bool InternalCanExecute(object parameter)
Parameters
Type | Name | Description |
---|---|---|
object | parameter | The command parameter |
Returns
Type | Description |
---|---|
bool | True if there is a current active layout displayed to the user |
Overrides
InternalExecuteAsync(object)
Closes the currently active layout. If the layout has pending changes the user will be prompted to save first
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 the operation |