Go to: Synopsis. Return value. Flags. MEL examples.
runTimeCommand [-addKeyword string] [-addTag string] [-annotation string] [-category string] [-categoryArray] [-command script] [-commandArray] [-commandLanguage string] [-default boolean] [-defaultCommandArray] [-delete] [-exists] [-helpUrl string] [-hotkeyCtx string] [-image string] [-keywords string] [-label string] [-longAnnotation string] [-numberOfCommands] [-numberOfDefaultCommands] [-numberOfUserCommands] [-plugin string] [-save] [-showInHotkeyEditor boolean] [-tags string] [-userCommandArray]
name
runTimeCommand is undoable, queryable, and editable.
Create a MEL command given the specified name. Once the command is created you can invoke it like any other MEL command. When the command is invoked it will execute the string attached to the command flag. Note that the resulting command takes no arguments, has no flags and may not be queried or edited. The command name you provide must be unique. The name itself must begin with an alphabetic character or underscore followed by alphanumeric characters or underscores. If you create your run time commands in a script which is automatically sourced at startup then set the default flag to true. This will prevent the application from attempting to save these commands.string | The name of the command on. |
In query mode, return type is based on queried flag.
Long name (short name) | Argument types | Properties | ||
---|---|---|---|---|
-addKeyword(-ak) 2023
|
string
|
|||
|
||||
-addTag(-at) 2023
|
string
|
|||
|
||||
-annotation(-ann)
|
string
|
|||
|
||||
-category(-cat)
|
string
|
|||
|
||||
-categoryArray(-caa)
|
|
|||
|
||||
-command(-c)
|
script
|
|||
|
||||
-commandArray(-ca)
|
|
|||
|
||||
-commandLanguage(-cl)
|
string
|
|||
|
||||
-default(-d)
|
boolean
|
|||
|
||||
-defaultCommandArray(-dca)
|
|
|||
|
||||
-delete(-del)
|
|
|||
|
||||
-exists(-ex)
|
|
|||
|
||||
-helpUrl(-url) 2023
|
string
|
|||
|
||||
-hotkeyCtx(-hc)
|
string
|
|||
|
||||
-image(-i)
|
string
|
|||
|
||||
-keywords(-k)
|
string
|
|||
|
||||
-label(-l)
|
string
|
|||
|
||||
-longAnnotation(-la)
|
string
|
|||
|
||||
-numberOfCommands(-nc)
|
|
|||
|
||||
-numberOfDefaultCommands(-ndc)
|
|
|||
|
||||
-numberOfUserCommands(-nuc)
|
|
|||
|
||||
-plugin(-p)
|
string
|
|||
|
||||
-save(-s)
|
|
|||
|
||||
-showInHotkeyEditor(-she)
|
boolean
|
|||
|
||||
-tags(-t)
|
string
|
|||
|
||||
-userCommandArray(-uca)
|
|
|||
|
Flag can appear in Create mode of command | Flag can appear in Edit mode of command |
Flag can appear in Query mode of command | Flag can be used more than once in a command. |
// Create a command that simply prints a message. After executing // the following lines enter the command name <i>MyHelloCommand</i> // in the Command Line. // if (!`runTimeCommand -exists MyHelloCommand`) { runTimeCommand -annotation "Print the word \"Hello\"" -command ("print \"Hello\\n\"") MyHelloCommand; } // Create a window with a button that invokes the <i>MyHelloCommand</i> // command. // window; paneLayout; button -command ("MyHelloCommand"); showWindow;