class in UnityEngine.UIElements
/
Inherits from:UIElements.TextInputBaseField_1
/
Implemented in:UnityEngine.UIElementsModule
Implements interfaces:IValueField<T0>
Base class for text fields.
| formatString | The format string for the value. |
| ApplyInputDeviceDelta | Applies the values of a 3D delta and a speed from an input device. |
| SetValueWithoutNotify | Allow to set the value without being notified. |
| StartDragging | Indicates the user started the mouse dragging for text selection. |
| StopDragging | Indicates the user stopped the mouse dragging for text selection. |
| AddLabelDragger | Method used to add a mouse dragger on the label for specific numeric fields. |
| alignedFieldUssClassName | USS class name of elements that are aligned in a inspector element |
| labelDraggerVariantUssClassName | USS class name of labels in elements of this type, when there is a dragger attached on them. |
| mixedValueLabelUssClassName | USS class name of elements that show mixed values |
| noLabelVariantUssClassName | USS class name of elements of this type, when there is no label. |
| inputUssClassName | USS class name of input elements in elements of this type. |
| labelUssClassName | USS class name of labels in elements of this type. |
| multilineInputUssClassName | USS class name of multiline input elements in elements of this type. |
| placeholderUssClassName | USS class name of input elements when placeholder text is shown |
| singleLineInputUssClassName | USS class name of single line input elements in elements of this type. |
| textInputUssName | USS class name of input elements in elements of this type. |
| ussClassName | USS class name of elements of this type. |
| disabledUssClassName | USS class name of local disabled elements. |
| label | The string representing the label that will appear beside the field. |
| labelElement | This is the Label object that appears beside the input for the field. |
| mixedValueLabel | Read-only label used to give the appearance of editing multiple different values. |
| rawValue | The value of the element. |
| showMixedValue | When set to true, gives the field the appearance of editing multiple different values. |
| value | The value associated with the field. |
| binding | Binding object that will be updated. |
| bindingPath | Path of the target property to be bound. |
| canGrabFocus | Return true if the element can be focused. |
| delegatesFocus | Whether the element should delegate the focus to its children. |
| focusable | True if the element can be focused. |
| focusController | Return the focus controller for this element. |
| tabIndex | An integer used to sort focusables in the focus ring. Must be greater than or equal to zero. |
| autoCorrection | Determines if the touch screen keyboard auto correction is turned on or off. |
| cursorColor | Color of the cursor. |
| cursorIndex | This is the cursor index in the text presented. |
| cursorPosition | The position of the text cursor inside the element. |
| doubleClickSelectsWord | Controls whether double clicking selects the word under the mouse pointer or not. |
| hideMobileInput | Hides or shows the mobile input field. |
| isDelayed | If set to true, the value property isn't updated until either the user presses Enter or the text field loses focus. |
| isPasswordField | Returns true if the field is used to edit a password. |
| isReadOnly | Returns true if the field is read only. |
| keyboardType | The type of mobile keyboard that will be used. |
| maskChar | The character used for masking in a password field. |
| maxLength | Maximum number of characters for the field. |
| onIsReadOnlyChanged | Calls the methods in its invocation list when isReadOnly changes. |
| selectAllOnFocus | Controls whether the element's content is selected upon receiving focus. |
| selectAllOnMouseUp | Controls whether the element's content is selected when you mouse up for the first time. |
| selectIndex | This is the selection index in the text presented. |
| selectionColor | Background color of selected text. |
| text | The value of the input field. |
| textEdition | Retrieves this Field's TextElement ITextEdition |
| textSelection | Retrieves this Field's TextElement ITextSelection |
| touchScreenKeyboard | The active touch keyboard being displayed. |
| tripleClickSelectsLine | Controls whether triple clicking selects the entire line under the mouse pointer or not. |
| verticalScrollerVisibility | Option for controlling the visibility of the vertical scroll bar in the TextInputBaseField_1. |
| childCount | Number of child elements in this object's contentContainer. |
| contentContainer | Child elements are added to it, usually this is the same as the element itself. |
| contentRect | The rectangle of the content area of the element, in the local space of the element. |
| customStyle | Returns the custom style properties accessor for this element. |
| enabledInHierarchy | Returns true if the VisualElement is enabled in its own hierarchy. |
| enabledSelf | Returns true if the VisualElement is enabled locally. |
| experimental | Returns the UIElements experimental interfaces. |
| generateVisualContent | Called when the VisualElement visual contents need to be (re)generated. |
| hierarchy | Access to this element physical hierarchy |
| languageDirection | Indicates the directionality of the element's text. The value will propagate to the element's children. |
| layout | The position and size of the VisualElement relative to its parent, as computed by the layout system. |
| localBound | Returns a Rect representing the Axis-aligned Bounding Box (AABB) after applying the transform, but before applying the layout translation. |
| name | The name of this VisualElement. |
| paddingRect | The rectangle of the padding area of the element, in the local space of the element. |
| panel | The panel onto which this VisualElement is attached. |
| parent | The parent of this VisualElement. |
| pickingMode | Determines if this element can be pick during mouseEvents or IPanel.Pick queries. |
| resolvedStyle | Returns the VisualElement resolved style values. |
| schedule | Retrieves this VisualElement's IVisualElementScheduler |
| style | Reference to the style object of this element. |
| styleSheets | Returns a VisualElementStyleSheetSet that manipulates style sheets attached to this element. |
| this[int] | Retrieves the child element at a specific index. |
| tooltip | Text to display inside an information box after the user hovers the element for a small amount of time. This is only supported in the Editor UI. |
| transform | Returns a transform object for this VisualElement. ITransform |
| usageHints | A combination of hint values that specify high-level intended usage patterns for the VisualElement. This property can only be set when the VisualElement is not yet part of a Panel. Once part of a Panel, this property becomes effectively read-only, and attempts to change it will throw an exception. The specification of proper UsageHints drives the system to make better decisions on how to process or accelerate certain operations based on the anticipated usage pattern. Note that those hints do not affect behavioral or visual results, but only affect the overall performance of the panel and the elements within. It's advised to always consider specifying the proper UsageHints, but keep in mind that some UsageHints might be internally ignored under certain conditions (e.g. due to hardware limitations on the target platform). |
| userData | This property can be used to associate application-specific user data with this VisualElement. |
| viewDataKey | Used for view data persistence (ie. tree expanded states, scroll position, zoom level). |
| visible | Indicates whether or not this element should be rendered. |
| visualTreeAssetSource | Stores the asset reference, if the generated element is cloned from a VisualTreeAsset. |
| worldBound | Returns a Rect representing the Axis-aligned Bounding Box (AABB) after applying the world transform. |
| worldTransform | Returns a matrix that cumulates the following operations (in order): -Local Scaling -Local Rotation -Local Translation -Layout Translation -Parent worldTransform (recursive definition - consider identity when there is no parent) |
| HasBubbleUpHandlers | Return true if event handlers for the event propagation BubbleUp phase have been attached on this object. |
| HasTrickleDownHandlers | Returns true if event handlers, for the event propagation TrickleDown phase, are attached to this object. |
| RegisterCallback | Adds 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. |
| UnregisterCallback | Remove callback from the instance. |
| Blur | Tell the element to release the focus. |
| Focus | Attempt to give the focus to this element. |
| MeasureTextSize | Computes the size needed to display a text string based on element style values such as font, font-size, and word-wrap. |
| SelectAll | Selects all the text contained in the field. |
| SelectNone | Remove selection |
| SelectRange | Select text between cursorIndex and selectIndex. |
| Add | Add an element to this element's contentContainer |
| AddToClassList | Adds a class to the class list of the element in order to assign styles from USS. Note the class name is case-sensitive. |
| BringToFront | Brings this element to the end of its parent children list. The element will be visually in front of any overlapping sibling elements. |
| Children | Returns the elements from its contentContainer. |
| ClassListContains | Searches for a class in the class list of this element. |
| Clear | Remove all child elements from this element's contentContainer |
| ClearClassList | Removes all classes from the class list of this element. AddToClassList |
| Contains | Checks if this element is an ancestor of the specified child element. |
| ContainsPoint | Checks if the specified point intersects with this VisualElement's layout. |
| ElementAt | Retrieves the child element at a specific index. |
| EnableInClassList | Enables or disables the class with the given name. |
| FindAncestorUserData | Searches up the hierarchy of this VisualElement and retrieves stored userData, if any is found. |
| FindCommonAncestor | Finds the lowest common ancestor between two VisualElements inside the VisualTree hierarchy. |
| GetClasses | Retrieve the classes for this element. |
| GetFirstAncestorOfType | Walks up the hierarchy, starting from this element's parent, and returns the first VisualElement of this type |
| GetFirstOfType | Walks up the hierarchy, starting from this element, and returns the first VisualElement of this type |
| IndexOf | Retrieves the child index of the specified VisualElement. |
| Insert | Insert an element into this element's contentContainer |
| MarkDirtyRepaint | Triggers a repaint of the VisualElement on the next frame. This method is called internally when a change occurs that requires a repaint, such as when BaseField.value is changed or the text in a Label. If you are implementing a custom control, you can call this method to trigger a repaint when a change occurs that requires a repaint such as when using generateVisualContent to render a mesh and the mesh data has now changed. |
| PlaceBehind | Places 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. |
| PlaceInFront | Places 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. |
| Remove | Removes this child from the contentContainerhierarchy. |
| RemoveAt | Remove the child element located at this position from this element's contentContainer |
| RemoveFromClassList | Removes a class from the class list of the element. |
| RemoveFromHierarchy | Removes this element from its parent hierarchy. |
| SendEvent | Sends an event to the event handler. |
| SendToBack | Sends this element to the beginning of its parent children list. The element will be visually behind any overlapping sibling elements. |
| SetEnabled | Changes the VisualElement enabled state. A disabled VisualElement does not receive most events. |
| Sort | Reorders child elements from this VisualElement contentContainer. |
| ToggleInClassList | Toggles between adding and removing the given class name from the class list. |
| UpdateMixedValueContent | Update the field's visual content depending on showMixedValue. |
| ExecuteDefaultAction | Executes logic after the callbacks registered on the event target have executed, unless the event has been marked to prevent its default behaviour. EventBase_1.PreventDefault. |
| ExecuteDefaultActionAtTarget | Executes logic after the callbacks registered on the event target have executed, unless the event is marked to prevent its default behaviour. EventBase_1.PreventDefault. |
| StringToValue | Converts a string to the value of the specified generic type from the subclass. |
| ValueToString | Converts a value of the specified generic type from the subclass to a string representation. |