IntegerField
UnityEngine.UIElements.IntegerField
읽는 시간 1분최근 업데이트: 한 달 전
An IntegerField lets users input a numerical integer value. It accepts and displays text input. You can set placeholder text to provide hints or instructions to the user on what to enter. You can also add validation functions to ensure that the entered data meets certain requirements.
Create an IntegerField
You can create an IntegerField with UI Builder, UXML, and C#. The following C# code creates an IntegerField:
var integerField = new IntegerField("Label text");
Set a placeholder text
You can set a placeholder text for the element. You can also hide the placeholder text on focus.
myElement.textEdition.placeholder = "Enter your value here";myElement.textEdition.hidePlaceholderOnFocus = true;
To style the placeholder text, use the USS selector.
.unity-base-text-field__input--placeholderCustomize the input text selection
Input text is selectable by default. You can customize the selection behaviors such as and .
selectAllOnMouseUPselectAllOnFocusIn C#, set them through :
textSelectionmyElement.textSelection.selectAllOnMouseUp = false;myElement.textSelection.selectAllOnFocus = false;
Example
The following UXML example creates an IntegerField:
<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements"> <IntegerField label="UXML Field" name="the-uxml-field" /></UXML>
The following USS example styles the IntegerField:
.some-styled-field { -unity-font-style: bold;}.some-styled-field .unity-base-field__input { -unity-font-style: italic;}
The following C# example illustrates some of the customizable functionalities of the IntegerField:
// Get a reference to the field from UXML and assign a value to it. var uxmlField = container.Q<IntegerField>("the-uxml-field"); uxmlField.value = 42; // Create a new field, disable it, and give it a style class. var csharpField = new IntegerField("C# Field"); csharpField.SetEnabled(false); csharpField.AddToClassList("some-styled-field"); csharpField.value = uxmlField.value; container.Add(csharpField); // Mirror the value of the UXML field into the C# field. uxmlField.RegisterCallback<ChangeEvent<int>>((evt) => { csharpField.value = evt.newValue; });
To try this example live in Unity, go to Window > UI Toolkit > Samples.
C# base class and namespace
C# class:
IntegerFieldNamespace:
UnityEngine.UIElementsBase class:
TextValueField_1Inherited UXML attributes
This element inherits the following attributes from its base class:
Name | Type | Description |
|---|---|---|
| | Determines if the touch screen keyboard auto correction is turned on or off. |
| | Path of the target property to be bound. |
| | Specifies the order in which the system should look for Emoji characters when rendering text. If this setting is enabled, the global Emoji Fallback list will be searched first for characters defined as Emoji in the Unicode 14.0 standard. |
| | Whether an element can potentially receive focus. If false, the element can't receive focus. If true, the element receives focus only when its |
| | Hides or shows the mobile input field. |
| | Hides the placeholder on focus. |
| | If set to true, the value property isn't updated until either the user presses Enter or the text field loses focus. |
| | The type of mobile keyboard that will be used. |
| | The string representing the label that will appear beside the field. If the string is empty, the label element is removed from the hierarchy. If the string is not empty, the label element is added to the hierarchy. |
| | The character used for masking in a password field. |
| | Maximum number of characters for the field. |
| | Returns true if the field is used to edit a password. |
| | A short hint to help users understand what to enter in the field. |
| | Returns true if the field is read only. |
| | Controls whether the element's content is selected upon receiving focus. |
| | Controls whether the element's content is selected when you mouse up for the first time. |
| | Controls whether triple clicking selects the entire line under the mouse pointer or not. |
| | Controls whether double-clicking selects the word under the mouse pointer. |
| | Indicates whether the field supports expressions that can be evaluated into a value. Expressions are mathematical or logical constructs, such as "1+1" or "5"2", which can be processed to produce a result. When this property is enabled, the field accepts additional characters required for expressions (e.g., '+', '-', '"', '/', etc.), expanding its functionality beyond the typical restrictions of a text field that might otherwise only allow digits. |
| | An integer used to sort focusable elements in the focus ring. Must be greater than or equal to zero. Setting the |
| | The value associated with the field. |
| | Option for controlling the visibility of the vertical scroll bar in the |
This element also inherits the following attributes from :
VisualElementName | Type | Description |
|---|---|---|
| | Logical container where child elements are added. If a child is added to this element, the child is added to this element's content container instead. When iterating over the If the content container is the same as the element itself, child elements are added directly to the element. This is true for most elements but can be overridden by more complex types. The |
| | Assigns a data source to this VisualElement which overrides any inherited data source. This data source is inherited by all children. |
| | Path from the data source to the value. |
| | The possible type of data source assignable to this VisualElement. This information is only used by the UI Builder as a hint to provide some completion to the data source path field when the effective data source cannot be specified at design time. |
| | Returns true if the This flag isn't changed if the VisualElement is disabled implicitly by one of its parents. To verify this, use |
| | Indicates the directionality of the element's text. The value will propagate to the element's children. |
| | The name of this VisualElement. Use this property to write USS selectors that target a specific element. The standard practice is to give an element a unique name. |
| | Determines if this element can be the target of pointer events or picked by Elements can not be picked if: - They are invisible- Their Elements with a picking mode of |
| | Sets the style values on a The returned style data, computed from USS files or inline styles written to this object in C#, doesn't represent the fully resolved styles, such as the final height and width of a VisualElement. To access these fully resolved styles, use For information about how to use this property and all the supported USS properties, refer to the Apply styles in C# scripts and USS properties reference manual pages. |
| | 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. |
| | A combination of hint values that specify high-level intended usage patterns for the |
| | Used for view data persistence, such as tree expanded states, scroll position, or zoom level. This key is used to save and load the view data from the view data store. If you don't set this key, the persistence is disabled for the associated |
USS classes
The following table lists all the C# public property names and their related USS selector.
C# property | USS selector | Description |
|---|---|---|
| | USS class name of elements of this type. |
| | USS class name of labels in elements of this type. |
| | USS class name of input elements in elements of this type. |
| | USS class name of elements of this type. |
| | USS class name of labels in elements of this type. |
| | USS class name of input elements in elements of this type. |
| | USS class name of single line input elements in elements of this type. |
| | USS class name of multiline input elements in elements of this type. |
| | USS class name of input elements when placeholder text is shown |
| | USS class name of elements of this type. |
| | USS class name of labels in elements of this type. |
| | USS class name of input elements in elements of this type. |
| | USS class name of elements of this type, when there is no label. |
| | USS class name of labels in elements of this type, when there is a dragger attached on them. |
| | USS class name of elements that show mixed values |
| | USS class name of elements that are aligned in a inspector element |
| | USS class name of local disabled elements. |
You can also use the Matching Selectors section in the Inspector or the UI Toolkit Debugger to see which USS selectors affect the components of the at every level of its hierarchy.
VisualElement