Class RuntimeCommand

Namespace

Hi.ShellCommandUtils

Assembly

HiNc.dll

Represents a shell command that can be executed at runtime.

public class RuntimeCommand : IShellCommand, IMakeXmlSource

Inheritance

object

RuntimeCommand

Implements

IShellCommand

IMakeXmlSource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])

InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)

InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)

ColorUtil.GetGloomyColor(object, double, double)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Constructors

RuntimeCommand()

Initializes a new instance of the RuntimeCommand class.

public RuntimeCommand()

RuntimeCommand(Action<ShellApi>)

Initializes a new instance of the RuntimeCommand class with the specified action.

public RuntimeCommand(Action<ShellApi> action)

Parameters

action Action<ShellApi>

The action to execute when this command is run.

Properties

Action

Gets or sets the action to execute when this command is run.

public Action<ShellApi> Action { get; set; }

Property Value

Action<ShellApi>

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

MakeXmlSource(string, string)

Creates an XML representation of the object. This method may also generate additional resources such as related files.

public XElement MakeXmlSource(string baseDirectory, string relFile)

Parameters

baseDirectory string

The base directory for resolving relative paths

relFile string

The relative file path for the XML source

Returns

XElement

An XML element representing the object's state

Remarks

For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied. The baseDirectory is typically the folder at the nearest configuration file folder. Since the folder can be moving with the configuration file.

Run(ShellApi)

Runs the command using the provided script API.

public IEnumerable<Action> Run(ShellApi shellApi)

Parameters

shellApi ShellApi

Returns

IEnumerable<Action>

Sequence of actions to be executed.