UserInterfaceTextBox Class |
A single line text box. Click it to give it keyboard focus, then type. The
characters go into the box instead of to the command line for as long as it
has focus; Enter commits what was typed, Escape puts back the text the box
started with, and both give the focus back to the viewport.
Inheritance HierarchySystemObject
Rhino.UIUserInterfaceObjectBase
Rhino.UIUserInterfaceControl
Rhino.UIUserInterfaceTextBox
Rhino.UIUserInterfaceObjectBase
Rhino.UIUserInterfaceControl
Rhino.UIUserInterfaceTextBox
Namespace: Rhino.UI
Assembly: RhinoCommon (in RhinoCommon.dll)
SyntaxThe UserInterfaceTextBox type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | UserInterfaceTextBox | Initializes a new instance of the UserInterfaceTextBox class |
| UserInterfaceTextBox(String) | Initializes a new instance of the UserInterfaceTextBox class |
Properties| Name | Description | |
|---|---|---|
 | BackgroundColor |
Color the box is filled with. Color.Empty, the default, means use the
standard color for the theme that is in use.
|
| BorderColor |
Color of the outline around the box. Color.Empty, the default, means use
the standard color for the theme that is in use. The outline is drawn
thicker and brighter while the box has keyboard focus, whatever color it
is given.
|
| BoundToActiveView | (Inherited from UserInterfaceObjectBase.) |
| CaretPosition |
Where the insertion point sits, as a count of characters from the start of
the text. Setting it clamps to the length of the text.
|
| HasKeyboardFocus |
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.) |
| HorizontalAlignment | (Inherited from UserInterfaceControl.) |
| Location | (Inherited from UserInterfaceControl.) |
| MaximumLength |
Most characters the text will hold. 0, the default, means no limit.
|
| PlaceholderText |
Text drawn, dimmed, when the box is empty and does not have focus
|
| ReadOnly |
A read only text box can take focus and be scrolled through, but typing
does not change it. False by default.
|
| Size | (Inherited from UserInterfaceControl.) |
| Text |
What the box holds. Unlike the other controls, this is something the user
changes, so reading it asks the box itself what is in it.
(Overrides UserInterfaceControlText.) |
| TextColor |
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.) |
| TextHeight |
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.) |
| TextHorizontalAlignment |
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.) |
| TextVerticalAlignment |
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.) |
| Tooltip |
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.) |
| TrackingPoint |
3d location that control "sticks" to if not null
(Inherited from UserInterfaceControl.) |
| VerticalAlignment | (Inherited from UserInterfaceControl.) |
| Visible |
Is the user interface object visible? Objects that are not visible will
not be drawn and will not receive mouse events
(Inherited from UserInterfaceObjectBase.) |
Methods| Name | Description | |
|---|---|---|
| ComputedRectangle | (Inherited from UserInterfaceControl.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsMouseOver |
Called to test if the mouse is actively over this object
(Inherited from UserInterfaceObjectBase.) |
| IsRegistered |
Is this user interface object active
(Inherited from UserInterfaceObjectBase.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnDraw |
All user interface objects are drawn and can customize their look
with the OnDraw function
(Inherited from UserInterfaceObjectBase.) |
| OnEditCanceled |
Called when Escape is pressed. The text has already been put back to what
it was when the box took focus. The default implementation raises the
EditCanceled event.
|
| OnKeyboardFocusChanged |
Called when the box gains or loses keyboard focus. Read HasKeyboardFocus
to find out which. The default implementation raises the
KeyboardFocusChanged event.
|
| OnMouseClick |
Called during a mouse click event on this object
(Inherited from UserInterfaceObjectBase.) |
| OnMouseDoubleClick |
Called during a mouse double click event on this object
(Inherited from UserInterfaceObjectBase.) |
| OnMouseDown |
Called when the mouse goes down on this object
(Inherited from UserInterfaceObjectBase.) |
| OnMouseEnter |
Called when the mouse goes over this object
(Inherited from UserInterfaceObjectBase.) |
| OnMouseLeave |
Called when the mouse leaves this object
(Inherited from UserInterfaceObjectBase.) |
| OnMouseMove |
Called when the mouse is moved
(Inherited from UserInterfaceObjectBase.) |
| OnMouseUp |
Called when the mouse is released on this object
(Inherited from UserInterfaceObjectBase.) |
| OnRunCommand |
Called after the above RunCommand function is called. This will be
executing while inside of a Rhino command.
(Inherited from UserInterfaceObjectBase.) |
| OnTextChanged |
Called every time the text changes, once per keystroke. The default
implementation raises the TextChanged event.
|
| OnTextCommitted |
Called when Enter is pressed, and when the box loses focus with the text
changed from what it started with. This is where you do something about
the new text. The default implementation raises the TextCommitted event.
|
| RegisterForAllDocuments |
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.) |
| RunCommand |
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.) |
| SetSvg | (Inherited from UserInterfaceControl.) |
| TakeKeyboardFocus |
Give this text box keyboard focus, as clicking it does
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Unregister |
Unregister this object
(Inherited from UserInterfaceObjectBase.) |
Events| Name | Description | |
|---|---|---|
 | EditCanceled |
Event triggered when Escape puts back the text the box started with
|
| KeyboardFocusChanged |
Event triggered when the box gains or loses keyboard focus
|
| TextChanged |
Event triggered every time the text changes, once per keystroke
|
| TextCommitted |
Event triggered when what was typed is committed, by Enter or by the box
losing focus with the text changed
|
See Also