Class ListCommand

Namespace

Hi.ShellCommands

Assembly

HiNc.dll

A command that contains and executes a list of other commands.

public class ListCommand : ITitleCommand, IShellCommand, IMakeXmlSource

Inheritance

object

ListCommand

Implements

ITitleCommand

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

ListCommand()

Default constructor.

public ListCommand()

ListCommand(XElement, string, string, params object[])

Ctor.

public ListCommand(XElement src, string baseDirectory, string relFile, params object[] res)

Parameters

src XElement

XML

baseDirectory string

Base directory for relative paths.

relFile string

Relative file path.

res object[]

Additional resources

Properties

CommandEntryList

Command List. The item in list is null capable.

public List<EnablingWrapper> CommandEntryList { get; set; }

Property Value

List<EnablingWrapper>

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

GetCommandTitle()

Gets the title of the command.

public string GetCommandTitle()

Returns

string

The command title.

MakeXmlSource(string, string, bool)

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, bool exhibitionOnly)

Parameters

baseDirectory string

The base directory for resolving relative paths

relFile string

The relative file path for the XML source

exhibitionOnly bool

if true, the extended file creation is suppressed.

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(RuntimeApi)

Runs the command using the provided script API.

public IEnumerable<Action> Run(RuntimeApi scriptApi)

Parameters

scriptApi RuntimeApi

Script API for executing milling commands.

Returns

IEnumerable<Action>

Sequence of actions to be executed.