Class ViewSystemItems
A toggle view command that toggles between viewing system items as well, or just non-system items.
System items are defined as those implementing IHasVersion with IsSystem set to true
Implements the filter by setting InternalFilter accordinglyInheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Commands.ViewCommands
Assembly: LemonEdge.ClientCore.dll
Syntax
public class ViewSystemItems : SingleToggleCommand, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IDisposable, IEPCommandWithDescriptor, IEPCommand, ICommand, ICommandDescriptor
Constructors
ViewSystemItems(IRootController, IBaseGridController)
Creates a new ViewSystemItems
Declaration
public ViewSystemItems(IRootController root, IBaseGridController controller)
Parameters
| Type | Name | Description |
|---|---|---|
| IRootController | root | The root controller, for service access. |
| IBaseGridController | controller | The grid control that hosts the collection of entities that can have system items amongst them |
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)
True - Can always toggle betwen viewing system items or not
Declaration
public override bool InternalCanExecute(object parameter)
Parameters
| Type | Name | Description |
|---|---|---|
| object | parameter | THe command parameter |
Returns
| Type | Description |
|---|---|
| bool | False |
Overrides
InternalExecuteAsync(object)
Toggles between viewing system items as well, or just non-system items.
System items are defined as those implementing IHasVersion with IsSystem set to true
Implements the filter by setting InternalFilter accordingly, and calling Redisplay()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 |