Class RefreshContext
This command executes the RefreshTab system command
Refreshes the current active tab if this command has a IModelLayoutHost as an owner, or the actual IModelLayoutDisplayer if that is the owner
Inherited Members
Namespace: LemonEdge.Client.Core.Commands
Assembly: LemonEdge.ClientCore.dll
Syntax
[CommandDescriptorOptions(Command.RefreshTab, null)]
public class RefreshContext : EPCommand, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IEPCommand, ICommand, IDisposableConstructors
RefreshContext(IRootController, IModelLayoutCommon)
Creates a new RefreshContext command
Declaration
public RefreshContext(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
True - This command reacts to changes in the active layout.
Declaration
protected override bool SubscribeToLayoutChange { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
Methods
InternalCanExecute(object)
Returns true if the layout to be refreshed is not displaying a new item as its main displayed item. You can not refresh something that is new.
Declaration
public override bool InternalCanExecute(object parameter)Parameters
| Type | Name | Description |
|---|---|---|
| object | parameter | The command parameter |
Returns
| Type | Description |
|---|---|
| bool | True if the layout to be refreshed is not displaying a new item as its main displayed item. You can not refresh something that is new. |
Overrides
InternalExecuteAsync(object)
Refreshes the current active tab if this command has a IModelLayoutHost as an owner, or the actual IModelLayoutDisplayer if that is the owner
The refresh actually refreshes the context for a layout, so if this context is shared across more than one layout than all those affected layouts will also be refreshed
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
Refresh(IModelLayoutDisplayer)
Refreshes the current active tab if this command has a IModelLayoutHost as an owner, or the actual IModelLayoutDisplayer if that is the owner
The refresh actually refreshes the context for a layout, so if this context is shared across more than one layout than all those affected layouts will also be refreshed
Declaration
public static Task Refresh(IModelLayoutDisplayer layout)Parameters
| Type | Name | Description |
|---|---|---|
| IModelLayoutDisplayer | layout | The layout to refresh the context of and reload |
Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operation |