Click or drag to resize

UserInterfaceControl Class

User interface controls are in-viewport control that act similar to controls you would find in most GUI frameworks. These are 2d screen aligned controls like buttons, labels and sliders
Inheritance Hierarchy
SystemObject
  Rhino.UIUserInterfaceObjectBase
    Rhino.UIUserInterfaceControl
      More...

Namespace:  Rhino.UI
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
public class UserInterfaceControl : UserInterfaceObjectBase

The UserInterfaceControl type exposes the following members.

Constructors
  NameDescription
Protected methodUserInterfaceControl
Initializes a new instance of the UserInterfaceControl class
Top
Properties
  NameDescription
Public propertyBoundToActiveView (Inherited from UserInterfaceObjectBase.)
Public propertyHasKeyboardFocus
Does this object have keyboard focus? An object with keyboard focus gets first refusal on what is typed in a viewport; what it does not use carries on to the command line as usual.
(Inherited from UserInterfaceObjectBase.)
Public propertyHorizontalAlignment
Public propertyLocation
Public propertySize
Public propertyText
Public propertyTextColor
Color used to draw the text. Color.Empty, the default, means use the standard text color for the theme that is in use.
Public propertyTextHeight
Height of the text in logical pixels. A value of 0, the default, means use the standard control font height. Controls that draw no text ignore this setting.
Public propertyTextHorizontalAlignment
Where the text sits inside the control's rectangle. This is not the same as HorizontalAlignment, which is where the control sits inside its parent.
Public propertyTextVerticalAlignment
Where the text sits inside the control's rectangle. This is not the same as VerticalAlignment, which is where the control sits inside its parent.
Public propertyTooltip
Text shown in a tooltip when the mouse rests over this object. Null or an empty string means no tooltip, which is what an object starts with. One tooltip is on screen at a time; whichever object the mouse is over owns it.
(Inherited from UserInterfaceObjectBase.)
Public propertyTrackingPoint
3d location that control "sticks" to if not null
Public propertyVerticalAlignment
Public propertyVisible
Is the user interface object visible? Objects that are not visible will not be drawn and will not receive mouse events
(Inherited from UserInterfaceObjectBase.)
Top
Methods
  NameDescription
Public methodComputedRectangle
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodIsMouseOver
Called to test if the mouse is actively over this object
(Inherited from UserInterfaceObjectBase.)
Public methodIsRegistered
Is this user interface object active
(Inherited from UserInterfaceObjectBase.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnDraw
All user interface objects are drawn and can customize their look with the OnDraw function
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseClick
Called during a mouse click event on this object
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseDoubleClick
Called during a mouse double click event on this object
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseDown
Called when the mouse goes down on this object
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseEnter
Called when the mouse goes over this object
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseLeave
Called when the mouse leaves this object
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseMove
Called when the mouse is moved
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseUp
Called when the mouse is released on this object
(Inherited from UserInterfaceObjectBase.)
Protected methodOnRunCommand
Called after the above RunCommand function is called. This will be executing while inside of a Rhino command.
(Inherited from UserInterfaceObjectBase.)
Public methodRegisterForAllDocuments
Make this object visible for all documents. Typically you will only have user interface objects work with single documents. For that case, call doc.ViewUserInterface.Add
(Inherited from UserInterfaceObjectBase.)
Public methodRunCommand
Call RunCommand to have the virtual OnRunCommand function executed in the scope of a Rhino command. If you are modifying the document from one of the mouse functions on this object, this is the best approach to do so since changes made inside of a command are recorded for undo.
(Inherited from UserInterfaceObjectBase.)
Public methodSetSvg
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUnregister
Unregister this object
(Inherited from UserInterfaceObjectBase.)
Top
See Also
Inheritance Hierarchy