Click or drag to resize
RhinoApp Class
.NET RhinoApp is parallel to C++ CRhinoApp.
Inheritance Hierarchy
SystemObject
  RhinoRhinoApp

Namespace: Rhino
Assembly: RhinoCommon (in RhinoCommon.dll) Version: 5.1.50000.0 (5.0.20693.0)
Syntax
public static class RhinoApp

The RhinoApp type exposes the following members.

Properties
  NameDescription
Public propertyStatic memberBuildDate
Gets the build date.
Public propertyStatic memberCommandHistoryWindowText
Text in Rhino's command history window.
Public propertyStatic memberCommandPrompt
Rhino command prompt.
Public propertyStatic memberCurrentRhinoId
Gets the current ID of Rhino.
Public propertyStatic memberDaysUntilExpiration
Returns number of days until license expires. Zero when license is expired. Raises InvalidLicenseTypeException if LicenseExpires would return false.
Public propertyStatic memberExeServiceRelease
Service release version of Rhino executable (0, 1, 2, ...) The integer is the service release number of Rhino. For example, this function returns "0" if Rhino V4SR0 is running and returns "1" if Rhino V4SR1 is running.
Public propertyStatic memberExeVersion
Major version of Rhino executable 4, 5, ...
Public propertyStatic memberInstallationType
Gets the product installation type, as seen in Rhino's ABOUT dialog box.
Public propertyStatic memberInvokeRequired
Returns true if we are currently not running on the main user interface thread
Public propertyStatic memberIsLicenseValidated
Returns true if the license is validated false otherwise
Public propertyStatic memberIsRunningAutomated
Is Rhino currently being executed through automation
Public propertyStatic memberLicenseExpires
Returns true if the license will expire false otherwise
Public propertyStatic memberLicenseSavesLeft
Returns number of saves left in save-limited Evaluation. Zero when evaluation is expired. Raises InvalidLicenseTypeException if LicenseType != EvaluationSaveLimited
Public propertyStatic memberName
Gets the application name.
Public propertyStatic memberNodeType
Gets license the node type.
Public propertyStatic memberRhino2Id
Gets the ID of Rhino 2.
Public propertyStatic memberRhino3Id
Gets the ID of Rhino 3.
Public propertyStatic memberRhino4Id
Gets the ID of Rhino 4.
Public propertyStatic memberRhino5Id
Gets the ID of Rhino 5.
Public propertyStatic memberSdkServiceRelease
Rhino SDK 9 digit SDK service release number in the form YYYYMMDDn Service service release of the Rhino SDK supported by this executable. Rhino will only load plug-ins that require a service release of <= this release number. For example, SR1 will load all plug-ins made with any SDK released up through and including the SR1 SDK. But, SR1 will not load a plug-in built using the SR2 SDK. If an "old" Rhino tries to load a "new" plug-in, the user is told that they have to get a free Rhino.exe update in order for the plug-in to load. Rhino.exe updates are available from http://www.rhino3d.com.
Public propertyStatic memberSdkVersion
Rhino SDK 9 digit SDK version number in the form YYYYMMDDn Rhino will only load plug-ins that were build with exactly the same version of the SDK.
Public propertyStatic memberSerialNumber
Gets the product serial number, as seen in Rhino's ABOUT dialog box.
Public propertyStatic memberToolbarFiles
Collection of currently open toolbar files in the application
Public propertyStatic memberValidationGracePeriodDaysLeft
Returns number of days within which validation must occur. Zero when validation grace period has expired. Raises InvalidLicenseTypeException if LicenseType is one of: EvaluationSaveLimited EvaluationTimeLimited Viewer Unknown
Public propertyStatic memberVersion
File version of the main Rhino process
Public propertyStatic memberVersionControlRevision
McNeel version control revision identifier at the time this version of Rhino was built.
Top
Methods
  NameDescription
Public methodStatic memberAskUserForRhinoLicense
Display UI asking the user to enter a license for Rhino or use one from the Zoo.
Public methodStatic memberClearCommandHistoryWindow
Clear the text in Rhino's command history window.
Public methodStatic memberExecuteCommand
Execute a Rhino command.
Public methodStatic memberExit
Exits, or closes, Rhino.
Public methodStatic memberGetDataDirectory(Boolean, Boolean)
Gets the data directory.
Public methodStatic memberGetDataDirectory(Boolean, Boolean, String)
Gets the data directory.
Public methodStatic memberGetPlugInObject(Guid)
Gets the object that is returned by PlugIn.GetPlugInObject for a given plug-in. This function attempts to find and load a plug-in with a given Id. When a plug-in is found, it's GetPlugInObject function is called and the result is returned here. Note the plug-in must have already been installed in Rhino or the plug-in manager will not know where to look for a plug-in with a matching id.
Public methodStatic memberGetPlugInObject(String)
Gets the object that is returned by PlugIn.GetPlugInObject for a given plug-in. This function attempts to find and load a plug-in with a given name. When a plug-in is found, it's GetPlugInObject function is called and the result is returned here. Note the plug-in must have already been installed in Rhino or the plug-in manager will not know where to look for a plug-in with a matching name.
Public methodStatic memberInvokeOnUiThread
Public methodStatic memberIsInstallationBeta
If licenseType is a beta license, returns true. A beta license grants full use of the product during the pre-release development period.
Public methodStatic memberIsInstallationCommercial
If licenseType is a commercial license, returns true. A commercial license grants full use of the product.
Public methodStatic memberIsInstallationEvaluation
If licenseType is an evaluation license, returns true. An evaluation license limits the ability of Rhino to save based on either the number of saves or a fixed period of time.
Public methodStatic memberMainWindowHandle
Gets the WindowHandle of the Rhino main window.
Public methodStatic memberReleaseMouseCapture
Releases the mouse capture.
Public methodStatic memberRunScript(String, Boolean)
Runs a Rhino command script.
Public methodStatic memberRunScript(String, String, Boolean)
Runs a Rhino command script.
Public methodStatic memberSendKeystrokes
Sends a string of printable characters, including spaces, to Rhino's command line.
Public methodStatic memberSetCommandPrompt(String)
Set Rhino command prompt.
Public methodStatic memberSetCommandPrompt(String, String)
Sets the command prompt in Rhino.
Public methodStatic memberSetFocusToMainWindow
Sets the focus to the main window.
Public methodStatic memberWait
Pauses to keep Windows message pump alive so views will update and windows will repaint.
Public methodStatic memberWrite(String)
Print formatted text in the command window.
Public methodStatic memberWrite(String, Object)
Print formatted text in the command window.
Public methodStatic memberWrite(String, Object, Object)
Print formatted text in the command window.
Public methodStatic memberWrite(String, Object, Object, Object)
Print formatted text in the command window.
Public methodStatic memberWriteLine
Print a newline in the command window.
Public methodStatic memberCode exampleWriteLine(String)
Print text in the command window.
Public methodStatic memberCode exampleWriteLine(String, Object)
Print formatted text with a newline in the command window.
Public methodStatic memberWriteLine(String, Object, Object)
Print formatted text with a newline in the command window.
Public methodStatic memberWriteLine(String, Object, Object, Object)
Print formatted text with a newline in the command window.
Top
Events
  NameDescription
Public eventStatic memberAppSettingsChanged
Is raised when settings are changed.
Public eventStatic memberClosing
Is raised when the application is about to close.
Public eventStatic memberEscapeKeyPressed
Can add or removed delegates that are raised when the escape key is clicked.
Public eventStatic memberIdle
Occurs when the application finishes processing and is about to enter the idle state
Public eventStatic memberInitialized
Is raised when the apllication is fully initialized.
Public eventStatic memberKeyboardEvent
Can add or removed delegates that are raised by a keyboard event.
Top
See Also