Skip to content
Will Pearson edited this page Aug 12, 2016 · 2 revisions

RhinoApp Class

.NET RhinoApp is parallel to C++ CRhinoApp.

Inheritance Hierarchy

System.Object
  Rhino.RhinoApp
Namespace: Rhino
Assembly: RhinoCommon (in RhinoCommon.dll) Version: Rhino 6.0

Syntax

C#

public static class RhinoApp

VB

Public NotInheritable Class RhinoApp

The RhinoApp type exposes the following members.

Properties

 

Name Description
Public propertyStatic member BuildDate Gets the build date.
Public propertyStatic member CommandHistoryWindowText Text in Rhino's command history window.
Public propertyStatic member CommandPrompt Rhino command prompt.
Public propertyStatic member CurrentRhinoId Gets the current ID of Rhino.
Public propertyStatic member DaysUntilExpiration Returns number of days until license expires. Zero when license is expired. Raises InvalidLicenseTypeException if LicenseExpires would return false.
Public propertyStatic member ExeServiceRelease 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 member ExeVersion Major version of Rhino executable 4, 5, ...
Public propertyStatic member InstallationType Gets the product installation type, as seen in Rhino's ABOUT dialog box.
Public propertyStatic member InvokeRequired Returns true if we are currently not running on the main user interface thread
Public propertyStatic member IsLicenseValidated Returns true if the license is validated false otherwise
Public propertyStatic member IsRunningAutomated Is Rhino currently being executed through automation
Public propertyStatic member LicenseExpires Returns true if the license will expire false otherwise
Public propertyStatic member LicenseSavesLeft Returns number of saves left in save-limited Evaluation. Zero when evaluation is expired. Raises InvalidLicenseTypeException if LicenseType != EvaluationSaveLimited
Public propertyStatic member Name Gets the application name.
Public propertyStatic member NodeType Gets license the node type.
Public propertyStatic member Rhino2Id Gets the ID of Rhino 2.
Public propertyStatic member Rhino3Id Gets the ID of Rhino 3.
Public propertyStatic member Rhino4Id Gets the ID of Rhino 4.
Public propertyStatic member Rhino5Id Gets the ID of Rhino 5.
Public propertyStatic member SdkServiceRelease 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 member SdkVersion 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 member SerialNumber Gets the product serial number, as seen in Rhino's ABOUT dialog box.
Public propertyStatic member ToolbarFiles Collection of currently open toolbar files in the application
Public propertyStatic member ValidationGracePeriodDaysLeft 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 member Version File version of the main Rhino process
Public propertyStatic member VersionControlRevision McNeel version control revision identifier at the time this version of Rhino was built.
  Back to Top

Methods

 

Name Description
Public methodStatic member AskUserForRhinoLicense Display UI asking the user to enter a license for Rhino or use one from the Zoo.
Public methodStatic member ClearCommandHistoryWindow Clear the text in Rhino's command history window.
Public methodStatic member ExecuteCommand
Public methodStatic member Exit Exits, or closes, Rhino.
Public methodStatic member GetDataDirectory(Boolean, Boolean) Gets the data directory.
Public methodStatic member GetDataDirectory(Boolean, Boolean, String) Gets the data directory.
Public methodStatic member GetPlugInObject(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 member GetPlugInObject(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 member InvokeOnUiThread
Public methodStatic member IsInstallationBeta 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 member IsInstallationCommercial If licenseType is a commercial license, returns true. A commercial license grants full use of the product.
Public methodStatic member IsInstallationEvaluation 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 member MainWindowHandle Gets the WindowHandle of the Rhino main window.
Public methodStatic member ReleaseMouseCapture Releases the mouse capture.
Public methodStatic member RunScript(String, Boolean) Runs a Rhino command script.
Public methodStatic member RunScript(String, String, Boolean) Runs a Rhino command script.
Public methodStatic member SendKeystrokes Sends a string of printable characters, including spaces, to Rhino's command line.
Public methodStatic member SetCommandPrompt(String) Set Rhino command prompt.
Public methodStatic member SetCommandPrompt(String, String) Sets the command prompt in Rhino.
Public methodStatic member SetFocusToMainWindow Sets the focus to the main window.
Public methodStatic member Wait Pauses to keep Windows message pump alive so views will update and windows will repaint.
Public methodStatic member Write(String) Print formatted text in the command window.
Public methodStatic member Write(String, Object) Print formatted text in the command window.
Public methodStatic member Write(String, Object, Object) Print formatted text in the command window.
Public methodStatic member Write(String, Object, Object, Object) Print formatted text in the command window.
Public methodStatic member WriteLine() Print a newline in the command window.
Public methodStatic memberCode example WriteLine(String) Print text in the command window.
Public methodStatic memberCode example WriteLine(String, Object) Print formatted text with a newline in the command window.
Public methodStatic member WriteLine(String, Object, Object) Print formatted text with a newline in the command window.
Public methodStatic member WriteLine(String, Object, Object, Object) Print formatted text with a newline in the command window.
  Back to Top

Events

 

Name Description
Public eventStatic member AppSettingsChanged Is raised when settings are changed.
Public eventStatic member Closing Is raised when the application is about to close.
Public eventStatic member EscapeKeyPressed Can add or removed delegates that are raised when the escape key is clicked.
Public eventStatic member Idle Occurs when the application finishes processing and is about to enter the idle state
Public eventStatic member Initialized Is raised when the apllication is fully initialized.
Public eventStatic member KeyboardEvent Can add or removed delegates that are raised by a keyboard event.
  Back to Top

Version Information

Supported in: 5D58w

See Also

Reference

Rhino Namespace

Clone this wiki locally