GH_DigitScrollerBase

Public Class

Provides Numeric digit scrolling GUI not tied to a control-handle.

Inheritance Hierarchy

System.Object
Grasshopper.GUI.Base.GH_TextBoxInputBase
Grasshopper.GUI.Base.GH_DigitScrollerBase

Namespace: Grasshopper.GUI.Base

Assembly: Grasshopper (in Grasshopper.dll)

Syntax

public class GH_DigitScrollerBase : GH_TextBoxInputBase

The GH_DigitScrollerBase type exposes the following members.

Constructors

Name

Description

---

Public Method

GH_DigitScrollerBase

Initializes a new instance of the GH_DigitScrollerBase class

---

Properties

Name

Description

---

Public Property

AllowRadixDrag

Gets or sets a value indicating whether the radix is allowed to be dragged around.

---

Public Property

AllowTextInput

Gets or sets whether text input is allowed by double click.

---

Public Property

AmplifyMotion

Gets or sets a value indicating whether vertical mouse drags should be amplified as the mouse moves further and further.

---

Public Property

BackgroundGradient

Gets or sets the background Gradient. If the gradient is not null, it overrides the background colours.

---

Public Property

BottomColour

Gets or sets the colour used along the bottom edge of the control.

---

Public Property

Bounds

Gets or sets the Bounds for this scroller.

(Overrides GH_TextBoxInputBase.Bounds.)

---

Public Property

DecimalPlaces

Gets or sets the number of decimal places available in this scroller. Unlike Radix, this property maintains the decimal position of the value represented by this scroller.

---

Public Property

DigitAlign

Gets or sets the digit align mode.

---

Public Property

Digits

Gets or sets the number of digits available in this scroller.

---

Public Property

DrawBackground

Gets or sets whether the background is drawn in this control.

---

Public Property

DrawBorder

Gets or sets whether the border is drawn in this control.

---

Public Property

DrawShadows

Gets or sets whether shadows are drawn in this control.

---

Public Property

EdgeColour

Gets or sets the edge colour of the control.

---

Public Property

Epsilon

Gets the smallest possible change in the value.

---

Public Property

Font

Gets or sets the Font for this scroller.

(Overrides

GH_TextBoxInputBase.Font

.)

---

Public Property

IsTextInput

Gets whether the text input box is currently on screen.

(Inherited from GH_TextBoxInputBase.)

---

Public Property

MaximumValue

Gets or sets the upper bound of the scroll value.

---

Public Property

MinimumValue

Gets or sets the lower bound of the scroll value.

---

Public Property

Prefix

Gets or sets the prefix text to be displayed on the scroller.

---

Public Property

PrefixBox

Gets the box containing the prefix string. If there is no prefix the PrefixBox will be Rectangle.Empty

---

Public Property

Radix

Gets or sets the radix index of this scroller.

---

Public Property

RadixBox

Gets the Radix box for this control, if there is no radix box, Rectangle.Empty will be returned.

---

Public Property

RailColour

Gets or sets the colour used for the rail line.

---

Public Property

RaiseEvents

Gets or sets whether this scroller raises the ValueChanged event.

---

Public Property

ScrollBoxes

Gets all scroll boxes (from left to right) for this control, not including the radix box.

---

Public Property

ShadowColour

Gets or sets the colour used for the shadows.

---

Public Property

ShadowSize

Gets or sets the size of the drop shadow along all four edges.

---

Public Property

SignBox

Gets the Sign box for this control.

---

Public Property

Suffix

Gets or sets the suffix text to be displayed on the scroller.

---

Public Property

SuffixBox

Gets the box containing the suffix string. If there is no suffix the PrefixBox will have zero width

---

Public Property

TextColour

Gets or sets the colour used for the text inside the scrolls.

---

Public Property

TopColour

Gets or sets the colour used along the top edge of the control.

---

Public Property

Value

Gets or sets the value displayed in this scroller.

---

Methods

Name

Description

---

Protected method

HandleTextInputAccepted

(Overrides

GH_TextBoxInputBase.HandleTextInputAccepted(String)

.)

---

Public Method

HideTextInputBox

Hides the text-input override form (if it is displayed).

(Inherited from GH_TextBoxInputBase.)

---

Public Method

MouseDown

Respond to mouse-down events.

---

Public Method

MouseMove

Respond to mouse-move events.

---

Public Method

MouseUp

Respond to mouse-up events.

---

Public Method

OnInvalidated

Raise the Invalidated event.

---

Public Method

OnValueChanged

Raise the ValueChanged event.

---

Public Method

Render

Render all UI elements.

---

Public Method

RespondToEnter

(Inherited from GH_TextBoxInputBase.)

---

Public Method

RespondToEscape

(Inherited from GH_TextBoxInputBase.)

---

Public Method

SetupScroller

Set the minimum, maximum and value fields simultaneously.

---

Public Method

ShowTextInputBox(Control)

---

Public Method

ShowTextInputBox(Control, Boolean)

---

Public Method

ShowTextInputBox(Control, Boolean, Matrix)

---

Public Method

ShowTextInputBox(Control, String, Boolean)

Display a floating text-box on top of the owner control.

(Inherited from GH_TextBoxInputBase.)

---

Public Method

ShowTextInputBox(Control, String, Boolean, Boolean)

Display a floating text-box on top of the owner control.

(Inherited from GH_TextBoxInputBase.)

---

Public Method

ShowTextInputBox(Control, String, Boolean, Boolean, Matrix)

Display a floating text-box on top of the owner control.

(Inherited from GH_TextBoxInputBase.)

---

Events

Name

Description

---

Public Event

Invalidated

Raised whenever the display of this scroller is changed, but not the value.

---

Public Event

ValueChanged

Raised whenever the value of this scroller is changed due to User-Interface methods.

---