Show / Hide Table of Contents

Class Command

A command to be sent to the server for processing

Inheritance
object
Command
HelpCommand
Implements
INoSerializationVerificationNeeded
Inherited Members
object.Equals(object, object)
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
Namespace: Petabridge.Cmd
Assembly: Petabridge.Cmd.Common.dll
Syntax
public class Command : INoSerializationVerificationNeeded

Constructors

Command(string, string, IEnumerable<Tuple<string, string>>)

Creates a new instance of a command for processing.

Declaration
public Command(string module, string name, IEnumerable<Tuple<string, string>> arguments)
Parameters
Type Name Description
string module

The module (or palette) that defines this command.

string name

The command name itself.

IEnumerable<Tuple<string, string>> arguments

The set of provided arguments.

Fields

Empty

Special case for unparseable commands

Declaration
public static readonly Command Empty
Field Value
Type Description
Command

Properties

Arguments

The set of arguments associated with this command.

Declaration
public IReadOnlyList<Tuple<string, string>> Arguments { get; }
Property Value
Type Description
IReadOnlyList<Tuple<string, string>>

Module

The name of the command palette for this argument.

Declaration
public string Module { get; }
Property Value
Type Description
string

Name

The name of the command being executed.

Declaration
public string Name { get; }
Property Value
Type Description
string

Methods

Equals(object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
object.Equals(object)

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
object.GetHashCode()

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
object.ToString()

ToString(bool)

Declaration
public string ToString(bool includeArgs)
Parameters
Type Name Description
bool includeArgs
Returns
Type Description
string

Implements

INoSerializationVerificationNeeded
In this article
Back to top Generated by DocFX