Click or drag to resize

UserInterfaceTextBox Properties

The UserInterfaceTextBox type exposes the following members.

Properties
  NameDescription
Public propertyBackgroundColor
Color the box is filled with. Color.Empty, the default, means use the standard color for the theme that is in use.
Public propertyBorderColor
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.
Public propertyBoundToActiveView (Inherited from UserInterfaceObjectBase.)
Public propertyCaretPosition
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.
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 propertyMaximumLength
Most characters the text will hold. 0, the default, means no limit.
Public propertyPlaceholderText
Text drawn, dimmed, when the box is empty and does not have focus
Public propertyReadOnly
A read only text box can take focus and be scrolled through, but typing does not change it. False by default.
Public propertySize (Inherited from UserInterfaceControl.)
Public propertyText
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.)
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
See Also