Click or drag to resize

UserInterfaceRadioButton Class

Draws a radio button with optional text beside it. Radio buttons that belong to the same group take turns: turning one on turns off whichever one was on before it, so exactly one button in a set is on at a time. Clicking a button that is already on does nothing.

A group is the radio buttons that share a Group number, sit in the same container and belong to the same document. The default group number is 0, so a set of radio buttons added to one grid is already a group. Give each set its own number when a container holds more than one set.

Inheritance Hierarchy
SystemObject
  Rhino.UIUserInterfaceObjectBase
    Rhino.UIUserInterfaceControl
      Rhino.UIUserInterfaceRadioButton

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

The UserInterfaceRadioButton type exposes the following members.

Constructors
  NameDescription
Public methodUserInterfaceRadioButton
Initializes a new instance of the UserInterfaceRadioButton class
Public methodUserInterfaceRadioButton(String)
Initializes a new instance of the UserInterfaceRadioButton class
Public methodUserInterfaceRadioButton(String, Int32)
Initializes a new instance of the UserInterfaceRadioButton class
Top
Properties
  NameDescription
Public propertyBoundToActiveView (Inherited from UserInterfaceObjectBase.)
Public propertyChecked
Is this the button that is on in its group? Turning a button on turns off every other button in its group. Setting this does not raise CheckedChanged; that is only for a state the user changed.
Public propertyCheckedButtonInGroup
The button in this button's group that is on, which can be this button, or null when nothing in the group has been turned on yet. The buttons have to have been added to a document for this to find anything, since it is the native side that keeps track of a group.
Public propertyGroup
Which set of radio buttons this one belongs to. The default is 0. Two sets of radio buttons in the same container need different group numbers or they will turn each other off.
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 (Inherited from UserInterfaceControl.)
Public propertyLocation (Inherited from UserInterfaceControl.)
Public propertySize (Inherited from UserInterfaceControl.)
Public propertyText (Inherited from UserInterfaceControl.)
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.
(Inherited from UserInterfaceControl.)
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.
(Inherited from UserInterfaceControl.)
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.
(Inherited from UserInterfaceControl.)
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.
(Inherited from UserInterfaceControl.)
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
(Inherited from UserInterfaceControl.)
Public propertyVerticalAlignment (Inherited from UserInterfaceControl.)
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 (Inherited from UserInterfaceControl.)
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 methodOnCheckedChanged
Called after a click or a key has changed the state of this button. Both ends of the change are told, the button that came on and the button that went off, so a set can be watched from any one of its buttons. The default implementation raises the CheckedChanged event.
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 (Inherited from UserInterfaceControl.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUnregister
Unregister this object
(Inherited from UserInterfaceObjectBase.)
Top
Events
  NameDescription
Public eventCheckedChanged
Event triggered when a click or a key changes the state of this radio button
Top
See Also