Draws a single line of text. Labels do not respond to the mouse; they are the descriptive text that goes beside the controls that do.

Constructors

UserInterfaceLabel

#Since v9.0
public UserInterfaceLabel()

UserInterfaceLabel

#Since v9.0
public UserInterfaceLabel(
text
)

Properties

BackgroundColor

Color the control is filled with: the face of a button, the track of a slider, the box of a check box or radio button, the field of a text box, the whole rectangle of a label, icon or grid. Color.Empty, the default, means the control chooses the color for the theme that is in use and follows the theme when it changes. Labels and icons draw no background when this is Color.Empty. A grid fills with the theme's panel color when it is a top level control, and draws no background when it is inside another control. UserInterfaceGrid.BackgroundOpacity makes the theme color see through, or turns the background off at 0.
public Color BackgroundColor { get; set; }
inherited fromUserInterfaceControl

BoundToActiveView

public bool BoundToActiveView { get; set; }
inherited fromUserInterfaceObjectBase

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.
public bool HasKeyboardFocus { get; }
inherited fromUserInterfaceObjectBase

HorizontalAlignment

public ControlHorizontalAlignment HorizontalAlignment { get; set; }
inherited fromUserInterfaceControl

Location

public PointF Location { get; set; }
inherited fromUserInterfaceControl

Size

public SizeF Size { get; set; }
inherited fromUserInterfaceControl

Text

public virtual string Text { get; set; }
inherited fromUserInterfaceControl

TextColor

Color used to draw the text. Color.Empty, the default, means use the standard text color for the theme that is in use.
public Color TextColor { get; set; }
inherited fromUserInterfaceControl

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.
public float TextHeight { get; set; }
inherited fromUserInterfaceControl

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.
public ControlHorizontalAlignment TextHorizontalAlignment { get; set; }
inherited fromUserInterfaceControl

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.
public ControlVerticalAlignment TextVerticalAlignment { get; set; }
inherited fromUserInterfaceControl

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.
public string Tooltip { get; set; }
inherited fromUserInterfaceObjectBase

TrackingPoint

3d location that control "sticks" to if not null
public Point3d? TrackingPoint { get; set; }
inherited fromUserInterfaceControl

VerticalAlignment

public ControlVerticalAlignment VerticalAlignment { get; set; }
inherited fromUserInterfaceControl

Visible

Is the user interface object visible? Objects that are not visible will not be drawn and will not receive mouse events
public bool Visible { get; set; }
inherited fromUserInterfaceObjectBase

Methods

ComputedRectangle

public RectangleF ComputedRectangle(
view,
logicalPixels
)
inherited fromUserInterfaceControl

IsMouseOver

Called to test if the mouse is actively over this object
protected virtual bool IsMouseOver()
inherited fromUserInterfaceObjectBase
Return true if the mouse is over this object

IsRegistered

Is this user interface object active
public bool IsRegistered()
inherited fromUserInterfaceObjectBase

OnDraw

All user interface objects are drawn and can customize their look with the OnDraw function
protected virtual void OnDraw()
inherited fromUserInterfaceObjectBase

OnMouseClick

Called during a mouse click event on this object
protected virtual void OnMouseClick()
inherited fromUserInterfaceObjectBase

OnMouseDoubleClick

Called during a mouse double click event on this object
protected virtual void OnMouseDoubleClick()
inherited fromUserInterfaceObjectBase

OnMouseDown

Called when the mouse goes down on this object
protected virtual void OnMouseDown(
mouse
Current mouse state when this event occurs
)
inherited fromUserInterfaceObjectBase

OnMouseEnter

Called when the mouse goes over this object
protected virtual void OnMouseEnter()
inherited fromUserInterfaceObjectBase

OnMouseLeave

Called when the mouse leaves this object
protected virtual void OnMouseLeave()
inherited fromUserInterfaceObjectBase

OnMouseMove

Called when the mouse is moved
protected virtual void OnMouseMove()
inherited fromUserInterfaceObjectBase

OnMouseUp

Called when the mouse is released on this object
protected virtual void OnMouseUp()
inherited fromUserInterfaceObjectBase

OnRunCommand

Called after the above RunCommand function is called. This will be executing while inside of a Rhino command.
protected virtual Result OnRunCommand(
doc,
Document that the command is running in
mode,
Interactive or scripted mode
mouse
Mouse state that was passed to RunCommand
)
inherited fromUserInterfaceObjectBase
Result of the command. The default implementation returns Success

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
public bool RegisterForAllDocuments()
inherited fromUserInterfaceObjectBase

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.
public void RunCommand(
mouse
Current mouse state. This is handed back to OnRunCommand
)
inherited fromUserInterfaceObjectBase

SetSvg

public void SetSvg(
svg
)
inherited fromUserInterfaceControl

Unregister

Unregister this object
public void Unregister()
inherited fromUserInterfaceObjectBase