Class NumericalField<TValueType>
Numerical Field UI element.
Inheritance
Implements
Inherited Members
Namespace: Unity.AppUI.UI
Assembly: solution.dll
Syntax
public abstract class NumericalField<TValueType> : ExVisualElement, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle, IValidatableElement<TValueType>, ISizeableElement, INotifyValueChanging<TValueType>, INotifyValueChanged<TValueType> where TValueType : struct, IComparable, IComparable<TValueType>, IFormattableType Parameters
| Name | Description |
|---|---|
| TValueType | The type of the numerical value. |
Constructors
| Name | Description |
|---|---|
| NumericalField() | Default constructor. |
Fields
| Name | Description |
|---|---|
| inputContainerUssClassName | The NumericalField input container styling class. |
| inputUssClassName | The NumericalField input styling class. |
| m_InputContainer | The input container. |
| m_InputElement | The input element. |
| m_LastValue | The last value of the element set during SetValueWithoutNotify(TValueType). |
| m_Size | The size of the element. |
| m_TrailingContainer | The trailing container. |
| m_UnitElement | The unit element. |
| m_Value | The value of the element. |
| sizeUssClassName | The NumericalField size styling class. |
| trailingContainerUssClassName | The NumericalField trailing container styling class. |
| unitUssClassName | The NumericalField unit styling class. |
| ussClassName | The NumericalField main styling class. |
Properties
| Name | Description |
|---|---|
| contentContainer | The content container of the element. |
| formatString | The format string of the element. |
| highValue | Maximum value. |
| invalid | The invalid state of the element. |
| lowValue | Minimum value. |
| size | The size of the element. |
| unit | The unit of the element. |
| validateValue | Method to validate the value. |
| value | The value of the element. |
Methods
| Name | Description |
|---|---|
| AreEqual(TValueType, TValueType) | Check if two values of type |
| GetIncrementFactor(TValueType) | Calculate the increment factor based on a base value. |
| Increment(TValueType, float) | Increment a given value with a given delta. |
| Max(TValueType, TValueType) | Return the biggest value between a and b. |
| Min(TValueType, TValueType) | Return the smallest value between a and b. |
| ParseStringToValue(string, out TValueType) | Define the conversion from the string value to a |
| ParseValueToString(TValueType) | Define the conversion from a |
| SetValueWithoutNotify(TValueType) | Set the value of the element without notifying the change. |