Class ImportData

Inheritance
object
BaseHasChildren<EPCommandWithDescriptor>
EPCommand
EPCommandWithDescriptor
ViewCommand
TaskBase
ImportData
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Commands
Assembly: LemonEdge.ClientEntities.dll
Syntax
public class ImportData : TaskBase, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IDisposable, IEPCommandWithDescriptor, IEPCommand, ICommand, ICommandDescriptor

Constructors

ImportData(IRootController, IModelLayoutCommon, bool, ImportSaveType)

Declaration
public ImportData(IRootController root, IModelLayoutCommon owner, bool runOnServer, ImportSaveType saveType)
Parameters
Type Name Description
IRootController root
IModelLayoutCommon owner
bool runOnServer
ImportSaveType saveType

Properties

Description

A user friendly description of this command

Declaration
public override string Description { get; }
Property Value
Type Description
string
Overrides

IconID

The image to use for this command, either a ImageType or ImageID

Declaration
public override Guid IconID { 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

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

InternalExecuteAsync(object)

Gets the parameters for the task (possibly prompting the user for som if GetParameters() override calls GetUserModifiedParametersFromDefault(IModelLayoutCommon, ServerTaskParameter)) and executes the task locally or against a task service depending on the setup

The system then also tracks the progress of the task in the application and notifies the user when the task is complete

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

Implements

Extension Methods