T_Rhino_Commands_Command - mcneel/rhinocommon-api-docs GitHub Wiki

Command Class

Defines a base class for all commands. This class is abstract.

Inheritance Hierarchy

System.Object
  Rhino.Commands.Command
    Rhino.Commands.SelCommand
    Rhino.Commands.TransformCommand
Namespace: Rhino.Commands
Assembly: RhinoCommon (in RhinoCommon.dll) Version: Rhino 6.0

Syntax

C#

public abstract class Command

VB

Public MustInherit Class Command

The Command type exposes the following members.

Constructors

 

Name Description
Protected method Command Default protected constructor. It only allows instantiation through subclassing.
  Back to Top

Properties

 

Name Description
Protected property CommandContextHelpUrl Gets the URL of the command contextual help. This is usually a location of a local CHM file. The default implementation return an empty string.
Public property EnglishName Gets the name of the command. This method is abstract.
Public property Id Gets the unique ID of this command. It is best to use a Guid attribute for each custom derived command class since this will keep the id consistent between sessions of Rhino GuidAttribute
Public propertyStatic member LastCommandId Gets the ID of the last commands.
Public propertyStatic member LastCommandResult Gets the result code of the last command.
Public property LocalName Gets the local name of the command.
Public property PlugIn Gets the plug-in where this commands is placed.
Public property Settings Gets the settings of the command.
  Back to Top

Methods

 

Name Description
Public methodStatic member DisplayHelp Displays help for a command.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodStatic member GetCommandNames Gets list of command names in Rhino. This list does not include Test, Alpha, or System commands.
Public methodStatic member GetCommandStack Determines if Rhino is currently running a command. Because Rhino allow for transparent commands (commands that can be run from inside of other commands), this method returns the total ids of active commands.
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public methodStatic member GetMostRecentCommands Gets an array of most recent command descriptions.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public methodStatic member InCommand Determines if Rhino is currently running a command.
Public methodStatic member InScriptRunnerCommand This is a low level tool to determine if Rhino is currently running a script running command like "ReadCommandFile" or the RhinoScript plug-in's "RunScript".
Public methodStatic member IsCommand Determines is a string is a command.
Public methodStatic member IsValidCommandName Determines if a string is a valid command name.
Public methodStatic member LookupCommandId Returns the ID of a command.
Public methodStatic member LookupCommandName Returns the command name given a command ID.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnHelp Is called when the user needs assistance with this command.
Protected method ReplayHistory Repeats an operation of a command. In order to make this function work, you will likely need to grab the Result property that gives the list of input objects. Then, you will be able to replace these inputs by using one of the UpdateToX() methods of the ReplayHistoryResult.

You should NOT use any document AddX() or ReplaceX() functions, as they will break history.

Protected method RunCommand Executes the command.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
  Back to Top

Events

 

Name Description
Public eventStatic member BeginCommand Called just before command.RunCommand().
Public eventStatic member EndCommand Called immediately after command.RunCommand().
Public eventStatic member UndoRedo Used to monitor Rhino's built in undo/redo support.
  Back to Top

Version Information

Supported in: 5D58w

See Also

Reference

Rhino.Commands Namespace

⚠️ **GitHub.com Fallback** ⚠️