Class GetUniqueID
A view command that opens a prompt for viewing and editing a Guid value, as a string. For example:
Guid myNewID = Guid.Empty;
var updateID = new GetUniqueID(View.Displayer,
() => myNewID,
(newID) => myNewID = newID,
() => CurrentDisplayedItem != null,
new LemonEdge.Core.Client.CommandDecriptor("Update ID", ImageType.UniqueID, "Update image unique reference ID.", ImageType.Image));
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Commands.ViewCommands
Assembly: LemonEdge.ClientCore.dll
Syntax
public class GetUniqueID : ViewCommand, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IDisposable, IEPCommandWithDescriptor, IEPCommand, ICommand, ICommandDescriptor
Constructors
GetUniqueID(IRootController, IModelLayoutDisplayer, Func<Guid?>, Action<Guid>, Func<bool>, ICommandDescriptor)
Creates a new GetUniqueID command
Declaration
public GetUniqueID(IRootController root, IModelLayoutDisplayer owner, Func<Guid?> getData, Action<Guid> setData, Func<bool> canExecute, ICommandDescriptor descriptor)
Parameters
Type | Name | Description |
---|---|---|
IRootController | root | The root controller, for service access. |
IModelLayoutDisplayer | owner | The owning host context for this command |
Func<Guid?> | getData | A function that returns the initial Guid value to be displayed to the user |
Action<Guid> | setData | A method that is called with the changed Guid value when the user accepts any changes |
Func<bool> | canExecute | A function that indicates if this command can be executed or not |
ICommandDescriptor | descriptor | A descriptor to use for the title, icone, etc and other attributes of this command |
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
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 if this command can be executed or not
Declaration
public override bool InternalCanExecute(object parameter)
Parameters
Type | Name | Description |
---|---|---|
object | parameter | The command parameter |
Returns
Type | Description |
---|---|
bool | True if this command can be executed |
Overrides
InternalExecuteAsync(object)
Displays a prompt to the user with a guid value that can be edited by the user
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 |