TextDotUserInterfaceObject

UserInterfaceObjectBase
User interface object that draws as a text dot

Constructors

TextDotUserInterfaceObject

#Since v9.0
Create a text dot styled user interface object at a defined location and text
public TextDotUserInterfaceObject(
location,
Location of object
text
Text content for dot
)

Properties

BoundToActiveView

public bool BoundToActiveView { get; set; }
inherited fromUserInterfaceObjectBase

DotBackgroundColor

#Since v9.0
Text dot background color
public Color DotBackgroundColor { get; set; }

DotBorderColor

#Since v9.0
Text dot border color
public Color DotBorderColor { get; set; }

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

MouseOverTextHeight

#Since v9.0
Font height used when the mouse is over the dot. The default behavior is to grow the dot a small amount when the mouse is over to help the user know that the dot is acts as a user interface object
public int MouseOverTextHeight { get; set; }

Text

#Since v9.0
Text content for grip
public string Text { get; set; }

TextColor

#Since v9.0
Text color used for dot text
public Color TextColor { get; set; }

TextHeight

#Since v9.0
Font height for text
public int TextHeight { get; set; }

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

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

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

Unregister

Unregister this object
public void Unregister()
inherited fromUserInterfaceObjectBase