Command Class |
Namespace: Rhino.Commands
The Command type exposes the following members.
Name | Description | |
---|---|---|
Command |
Default protected constructor. It only allows instantiation through sub-classing.
|
Name | Description | |
---|---|---|
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. | |
EnglishName |
Gets the name of the command.
This method is abstract.
| |
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 | |
LastCommandId |
Gets the ID of the last commands.
| |
LastCommandResult |
Gets the result code of the last command.
| |
LocalName |
Gets the local name of the command.
| |
PlugIn |
Gets the plug-in where this commands is placed.
| |
Settings |
Gets the settings of the command.
|
Name | Description | |
---|---|---|
DisplayHelp |
Displays help for a command.
| |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetCommandNames |
Gets list of command names in Rhino. This list does not include Test, Alpha, or System commands.
| |
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.
| |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetMostRecentCommands |
Gets an array of most recent command descriptions.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
InCommand |
Determines if Rhino is currently running a command.
| |
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".
| |
IsCommand |
Determines is a string is a command.
| |
IsValidCommandName |
Determines if a string is a valid command name.
| |
LookupCommandId |
Returns the ID of a command.
| |
LookupCommandName |
Returns the command name given a command ID.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnHelp |
Is called when the user needs assistance with this command.
| |
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. | |
RunCommand |
Executes the command.
| |
RunProxyCommand |
Execute some code as if it were running in a command
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Name | Description | |
---|---|---|
BeginCommand |
Called just before command.RunCommand().
| |
EndCommand |
Called immediately after command.RunCommand().
| |
UndoRedo |
Used to monitor Rhino's built in undo/redo support.
|