DoubleField

class in UnityEditor.UIElements

/

Inherits from:UIElements.TextValueField_1

/

Implemented in:UnityEditor

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Makes a text field for entering doubles.

Static Properties

inputUssClassNameUSS class name of input elements in elements of this type.
labelUssClassNameUSS class name of labels in elements of this type.
ussClassNameUSS class name of elements of this type.

Constructors

DoubleFieldConstructor.

Public Methods

ApplyInputDeviceDeltaModify the value using a 3D delta and a speed, typically coming from an input device.

Protected Methods

StringToValueConverts the given string to a double.
ValueToStringConverts the given double to a string.

Inherited Members

Static Properties

inputUssClassNameUSS class name of input elements in elements of this type.
labelDraggerVariantUssClassNameUSS class name of labels in elements of this type, when there is a dragger attached on them.
labelUssClassNameUSS class name of labels in elements of this type.
noLabelVariantUssClassNameUSS class name of elements of this type, when there is no label.
ussClassNameUSS class name of elements of this type.
inputUssClassNameUSS class name of input elements in elements of this type.
labelUssClassNameUSS class name of labels in elements of this type.
textInputUssNameUSS class name of input elements in elements of this type.
ussClassNameUSS class name of elements of this type.

Properties

labelThe string representing the label that will appear beside the field.
labelElementThis is the Label object that appears beside the input for the field.
rawValueThe value of the element.
valueThe value associated with the field.
bindingBinding object that will be updated.
bindingPathPath of the target property to be bound.
canGrabFocusReturn true if the element can be focused.
delegatesFocusWhether the element should delegate the focus to its children.
focusableTrue if the element can be focused.
focusControllerReturn the focus controller for this element.
tabIndexAn integer used to sort focusables in the focus ring. Must be greater than or equal to zero.
cursorColorColor of the cursor.
cursorIndexThe current cursor position index in the text input field.
doubleClickSelectsWordControls whether double clicking selects the word under the mouse pointer or not.
isDelayedIf set to true, the value property is not updated until either the user presses Enter or the text field loses focus.
isPasswordFieldReturns true if the field is used to edit a password.
isReadOnlyReturns true if the field is read only.
maskCharThe character used for masking in a password field.
maxLengthMaximum number of characters for the field.
selectIndexThe current selection position index in the text input field.
selectionColorBackground color of selected text.
textInputBaseThis is the text input visual element which presents the value in the field.
tripleClickSelectsLineControls whether triple clicking selects the entire line under the mouse pointer or not.
formatStringThe format string for the value.
valueThis is the value of the field.
childCount Number of child elements in this object's contentContainer
contentContainer child elements are added to this element, usually this
customStyleReturns the custom style properties accessor for this element.
enabledInHierarchyReturns true if the VisualElement is enabled in its own hierarchy.
enabledSelfReturns true if the VisualElement is enabled locally.
hierarchy Access to this element physical hierarchy
pickingModeDetermines if this element can be pick during mouseEvents or IPanel.Pick queries.
resolvedStyleReturns the VisualElement resolved style values.
scheduleRetrieves this VisualElement's IVisualElementScheduler
styleReference to the style object of this element.
styleSheetsReturns a VisualElementStyleSheetSet that manipulates style sheets attached to this element.
this[int] Access to this element physical hierarchy
tooltipText to display inside an information box after the user hovers the element for a small amount of time.
userDataThis property can be used to associate application-specific user data with this VisualElement.
viewDataKeyUsed for view data persistence (ie. tree expanded states, scroll position, zoom level).

Public Methods

SetValueWithoutNotifyAllow to set a value without being notified of the change, if any.
HandleEventHandle an event, most often by executing the callbacks associated with the event.
HasBubbleUpHandlersReturn true if event handlers for the event propagation BubbleUp phase have been attached on this object.
HasTrickleDownHandlersReturns true if event handlers, for the event propagation TrickleDown phase, are attached to this object.
RegisterCallbackAdds an event handler to the instance. If the event handler has already been registered for the same phase (either TrickleDown or BubbleUp) then this method has no effect.
SendEventSends an event to the event handler.
UnregisterCallbackRemove callback from the instance.
BlurTell the element to release the focus.
FocusAttempt to give the focus to this element.
SelectAllSelects all the text.
ApplyInputDeviceDeltaModify the value using a 3D delta and a speed, typically coming from an input device.
SetValueWithoutNotifyAllow to set the value without being notified.
StartDraggingIndicates the user started the mouse dragging for text selection.
StopDraggingIndicates the user stopped the mouse dragging for text selection.
AddAdd an element to this element's contentContainer
BringToFrontBrings this element to the end of its parent children list. The element will be visually in front of any overlapping sibling elements.
ChildrenReturns the elements from its contentContainer
ClearRemove all child elements from this element's contentContainer
ContainsReturns true if the element is a direct child of this VisualElement
ElementAtRetrieves the child element at position
EnableInClassListEnables or disables the class with the given name.
FindAncestorUserDataSearchs up the hierachy of this VisualElement and retrieves stored userData, if any is found.
FindCommonAncestorFinds the lowest commont ancestor between two VisualElements inside the VisualTree hierarchy
GetFirstAncestorOfTypeWalks up the hierarchy, starting from this element's parent, and returns the first VisualElement of this type
GetFirstOfTypeWalks up the hierarchy, starting from this element, and returns the first VisualElement of this type
IndexOfRetrieves the child index of the specified VisualElement.
InsertInsert an element into this element's contentContainer
MarkDirtyRepaintTriggers a repaint of the VisualElement on the next frame.
PlaceBehindPlaces this element right before the sibling element in their parent children list. If the element and the sibling position overlap, the element will be visually behind of its sibling.
PlaceInFrontPlaces this element right after the sibling element in their parent children list. If the element and the sibling position overlap, the element will be visually in front of its sibling.
RemoveRemoves this child from the hierarchy
RemoveAtRemove the child element located at this position from this element's contentContainer
RemoveFromHierarchyRemoves this element from its parent hierarchy
SendEventSends an event to the event handler.
SendToBackSends this element to the beginning of its parent children list. The element will be visually behind any overlapping sibling elements.
SetEnabledChanges the VisualElement enabled state. A disabled VisualElement does not receive most events.
SortReorders child elements from this VisualElement contentContainer.
ToggleInClassListToggles between adding and removing the given class name from the class list.

Protected Methods

AddLabelDraggerMethod used to add a mouse dragger on the label for specific numeric fields.
ValueToStringConverts the given value to a string.

Did you find this page useful? Please give it a rating: