Class Save
This command executes the Save system command
Saves any changes made against the active displayed layout, or specified layout, and refreshes the layout(s) when the save completes successfuly
This also prompts the user with any custom save dialogs through IHasSaveProcessingTask implementations and tracks any tasks created during the save process so the user can see their progressImplements
Inherited Members
Namespace: LemonEdge.Client.Core.Commands
Assembly: ClientCore.dll
Syntax
[CommandDescriptorOptions(Commands.Save, null)]
public class Save : EPCommand, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IEPCommand, ICommand, IDisposableConstructors
Save(IModelLayoutCommon)
Creates a new Save command
Declaration
public Save(IModelLayoutCommon owner)Parameters
| Type | Name | Description |
|---|---|---|
| IModelLayoutCommon | owner | The owning context for this command |
Properties
SubscribeToLayoutChange
Returns true indicating this command should respond to the current selected layout changing
Declaration
public override bool SubscribeToLayoutChange { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
Methods
InternalCanExecute(Object)
Returns true if the active, or specified, layout has pending changes and a save is currently being executed
Declaration
public override bool InternalCanExecute(object parameter)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | parameter | The command parameter |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the active, or specified, layout has pending changes and a save is currently being executed |
Overrides
InternalExecuteAsync(Object)
Saves any changes made against the active displayed layout, or specified layout, and refreshes the layout(s) when the save completes successfuly
This also prompts the user with any custom save dialogs through IHasSaveProcessingTask implementations and tracks any tasks created during the save process so the user can see their progress
Declaration
public override Task InternalExecuteAsync(object parameter)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | parameter | The command parameter |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A task indicating the completion of the operation |
Overrides
SaveLayout(IModelLayoutDisplayer, Boolean)
Saves any changes made against the specified layout, and refreshes the layout(s) when the save completes successfuly
This also prompts the user with any custom save dialogs through IHasSaveProcessingTask implementations and tracks any tasks created during the save process so the user can see their progress
Declaration
public static Task<bool> SaveLayout(IModelLayoutDisplayer layout, bool refreshAfter)Parameters
| Type | Name | Description |
|---|---|---|
| IModelLayoutDisplayer | layout | The specified layout to save the changes for |
| System.Boolean | refreshAfter | Indicates that once sucessfully saved the system should refresh the layout (and any others using that context) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Boolean> | True if the save was successful |