Class EnablingWrapper

Namespace

Hi.ShellCommands

Assembly

HiNc.dll

Wrapper for shell commands that provides enable/disable functionality.

public class EnablingWrapper : IShellCommand, IMakeXmlSource

Inheritance

object

EnablingWrapper

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

EnablingWrapper()

Ctor.

public EnablingWrapper()

EnablingWrapper(IShellCommand)

Initializes a new instance of the EnablingWrapper class with the specified command.

public EnablingWrapper(IShellCommand command)

Parameters

command IShellCommand

The command to wrap.

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

Ctor.

public EnablingWrapper(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

Command

Gets or sets the wrapped shell command.

public IShellCommand Command { get; set; }

Property Value

IShellCommand

IsEnabled

Gets or sets whether the wrapped command is enabled.

public bool IsEnabled { get; set; }

Property Value

bool

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

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.