Class ObfuscateFieldsTask
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Commands
Assembly: LemonEdge.ClientCore.dll
Syntax
[CommandDescriptorOptions(Command.ObfuscateFieldTask, null)]
public class ObfuscateFieldsTask : TaskBase, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IDisposable, IEPCommandWithDescriptor, IEPCommand, ICommand, ICommandDescriptor
Constructors
ObfuscateFieldsTask(IRootController, IModelLayoutCommon)
Declaration
public ObfuscateFieldsTask(IRootController root, IModelLayoutCommon owner)
Parameters
Type | Name | Description |
---|---|---|
IRootController | root | |
IModelLayoutCommon | owner |
Methods
GetParameters()
A function that returns the default parameters to use when creating this task
Used in conjunction with GetUserModifiedParametersFromDefault(IModelLayoutCommon, ServerTaskParameter) so hardcoded values can automatically be set, and the user can be prompted for any other required parameter selections if required
Declaration
protected override Task<ServerTaskParameter> GetParameters()
Returns
Type | Description |
---|---|
Task<ServerTaskParameter> | A task with the parameters, allowing optional popups to be shown to the user for parameter selection |
Overrides
Remarks
For instance:
protected override Task<ServerTaskParameter> GetParameters()
{
var ps = new API.Tasks.Parameters.ResetAccountParameter();
ps.AccountID = accountID;
ps.AccountID_Label = accountName;
return GetUserModifiedParametersFromDefault(Owner, ps);
}
InternalCanExecute(object)
Returns if this command can be executed or not from the client application UI
You must override InternalCanExecute(object?) or InternalCanExecuteAsync(object?) in order to implement if it can be executed
Declaration
public override bool InternalCanExecute(object parameter)
Parameters
Type | Name | Description |
---|---|---|
object | parameter | The command parameter |
Returns
Type | Description |
---|---|
bool | If this command can be executed or not from the client application UI |
Overrides
InternalExecuteUserWarning()
Provides a mechanism for implementing commands to issue a warning to the user before executing. Can return false to abort the execution.
Declaration
protected override Task<bool> InternalExecuteUserWarning()
Returns
Type | Description |
---|---|
Task<bool> | True to continue executing the aommand (default) |