RhinoAppRunScript Method (UInt32, String, String, Boolean) |
Runs a Rhino command script.
Namespace:
Rhino
Assembly:
RhinoCommon (in RhinoCommon.dll)
Since: 7.12
Syntax public static bool RunScript(
uint documentSerialNumber,
string script,
string mruDisplayString,
bool echo
)
Public Shared Function RunScript (
documentSerialNumber As UInteger,
script As String,
mruDisplayString As String,
echo As Boolean
) As Boolean
Parameters
- documentSerialNumber
- Type: SystemUInt32
[in] Document serial number for the document to run the script for. - script
- Type: SystemString
[in] script to run. - mruDisplayString
- Type: SystemString
[in] String to display in the most recent command list. - echo
- Type: SystemBoolean
[in]
Controls how the script is echoed in the command output window.
false = silent - nothing is echoed.
true = verbatim - the script is echoed literally.
Return Value
Type:
Boolean[Missing <returns> documentation for "M:Rhino.RhinoApp.RunScript(System.UInt32,System.String,System.String,System.Boolean)"]
Exceptions Remarks
Rhino acts as if each character in the script string had been typed in the command prompt.
When RunScript is called from a "script runner" command, it completely runs the
script before returning. When RunScript is called outside of a command, it returns and the
script is run. This way menus and buttons can use RunScript to execute complicated functions.
See Also