Class ResetLayout
Resets the configured layout to the default system one - you'll need to close and open the layout if it is already open.
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Commands.ViewCommands
Assembly: LemonEdge.ClientCore.dll
Syntax
public class ResetLayout : ViewCommand, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IDisposable, IEPCommandWithDescriptor, IEPCommand, ICommand, ICommandDescriptorConstructors
ResetLayout(IRootController, IGridSelector, IModelLayoutDisplayer)
Creates a new ResetLayout command
Declaration
public ResetLayout(IRootController root, IGridSelector view, IModelLayoutDisplayer displayer)Parameters
| Type | Name | Description |
|---|---|---|
| IRootController | root | The root controller, for service access. |
| IGridSelector | view | The grid of ILayout this command interacts with |
| IModelLayoutDisplayer | displayer | The parent context the command operates within |
Properties
Description
A user friendly description of this command
Declaration
public override string Description { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
IconID
Declaration
public override Guid IconID { get; }Property Value
| Type | Description |
|---|---|
| Guid |
Overrides
IncludeInSimple
By default view commands are included in any simple layout filtering of commands if they are part of the quick access
Declaration
public override bool IncludeInSimple { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
OverlayIconID
On some clients another image can be overlayed on the bottom right of the main icon (for indicating add, remove, etc)
This optional overlay image can be specified here, either a ImageType or ImageID
Declaration
public override Guid? OverlayIconID { 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
ToolTip
A user friendly tool tip for this command functionality, by default the Description
Declaration
public override string ToolTip { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
Methods
InternalCanExecute(object)
Returns true if the grid has any selected ILayout rows
Declaration
public override bool InternalCanExecute(object parameter)Parameters
| Type | Name | Description |
|---|---|---|
| object | parameter | The comand parameter |
Returns
| Type | Description |
|---|---|
| bool | True if the grid has any selected ILayout rows |
Overrides
InternalExecuteAsync(object)
Resets the configured layout to the default system one - you'll need to close and open the layout if it is already open.
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 |
Overrides
RemoveEventHandlersOnDispose()
Provides an inheriting command the opoortunity to remove any event handlers being listened to before this command is disposed
Declaration
protected override void RemoveEventHandlersOnDispose()Overrides
Reset(ILayout, IModelLayoutDisplayer, bool)
Resets the configured layout to the default system one - you'll need to close and open the layout if it is already open.
Declaration
public static Task Reset(ILayout layout, IModelLayoutDisplayer displayer, bool force)Parameters
| Type | Name | Description |
|---|---|---|
| ILayout | layout | The configrued layout to reset to the default system one if there is one |
| IModelLayoutDisplayer | displayer | The context within which this command operates |
| bool | force |
Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operation |