UIElements开发人员指南7 UXML elements reference （UXML元素参考）

UXML元素参考

下表概述了UnityEngine.UIElements和UnityEditor.UIElements名称空间中可用的UXML元素。

基本要素

元件	功能	命名空间	允许的子元素	属性
VisualElement	所有视觉元素的基类。	UnityEngine.UIElements	任意数量的VisualElement	class：空格分隔名称列表。 style：USS指令来设置元素的样式。 name：此元素的唯一字符串标识符。 picking-mode：设为Position或Ignore。默认值为Position。 tooltip：当鼠标悬停元素时，会显示一个字符串。 focusable：一个布尔值，指示元素是否可聚焦。默认设置为false（不可聚焦）。这取代了过时的focus-index元素。 tabindex：一个整数，用于定义元素的Tab键位置和树中的位置。正值会增加标签优先级。默认值为0.这将替换过时的focus-index元素。 view-data-key：一个字符串，用于定义用于序列化元素的键。 此元素还接受任何其他属性。
BindableElement	一个可以绑定到的元素SerializedProperty。属性的值和显示的值是同步的。	UnityEngine.UIElements	任意数量的VisualElement	binding-path：此元素绑定的属性的路径。

公用事业

元件	功能	命名空间	允许的子元素	属性
Box	此元素类似于VisualElement但在其内容周围绘制一个框。	UnityEngine.UIElements	任意数量的VisualElement	VisualElement所有属性
TextElement	显示文本的元素。	UnityEngine.UIElements	没有	VisualElement所有属性 text：元素应显示的文本。
Label	文字标签。	UnityEngine.UIElements	没有	TextElement所有属性
Image	显示图像。	UnityEngine.UIElements	没有	VisualElement所有属性
IMGUIContainer	绘制IMGUI内容	UnityEngine.UIElements	没有	VisualElement focus-index默认值的所有属性都是0 focusable默认值true
Foldout	具有切换按钮以显示或隐藏其内容的元素。	UnityEngine.UIElements	任意数量的VisualElement	BindableElement所有属性

模板

元件	功能	命名空间	允许的子元素	属性
Template	对可以使用该Instance元素实例化的另一个UXML模板的引用。	UnityEngine.UIElements	没有	name：此元素的唯一字符串标识符 path：要加载的UXML文件的路径
Instance	一个实例 Template	UnityEngine.UIElements	没有	template：的name的Template实例
TemplateContainer	模板容器。	UnityEngine.UIElements	没有	BindableElement所有属性 template：此模板的字符串标识符

控件

元件	功能	命名空间	允许的子元素	属性
BaseField<T>	所有字段的抽象基类。	UnityEngine.UIElements	没有	BindableElement focus-index默认值的所有属性都是0 focusable默认值是true label：与该字段关联的标签的文本
BaseFieldTraits<ValueType, UxmlType>		UnityEngine.UIElements	没有	BaseField<ValueType>所有属性 value：字段的基本值，类型ValueType
Button	标准按钮。	UnityEngine.UIElements	没有	TextElement所有属性
RepeatButton	按下时反复执行操作的按钮。	UnityEngine.UIElements	没有	TextElement所有属性 delay：执行元素执行操作之前的初始延迟（以毫秒为单位）。默认值为0 interval：重复每个操作之间的间隔（以毫秒为单位）。默认值为0
Toggle	切换按钮，显示为复选框。	UnityEngine.UIElements	没有	BaseFieldTraits<bool, UxmlBoolAttributeDescription>所有属性 text：切换的右侧标签。
Scroller	滚动条。	UnityEngine.UIElements	没有	VisualElement所有属性 low-value：滚动条的最小值：滚动条 high-value的最大值 direction：设置为Horizontal或Vertical。默认是Vertical。 value：滚动条光标的位置
Slider	一个滑块。	UnityEngine.UIElements	没有	BaseFieldTraits<float, UxmlFloatAttributeDescription>所有属性 low-value：滑块的最小值：滑块 high-value的最大值 direction：设置为Horizontal或Vertical。默认是Horizontal。 page-size：滑块的页面大小
SliderInt	整数值的滑块。	UnityEngine.UIElements	没有	BaseFieldTraits<int, UxmlIntAttributeDescription>所有属性 low-value：滑块的最小值：滑块 high-value的最大值 direction：设置为Horizontal或Vertical。默认是Horizontal。 page-size：滑块的页面大小
MinMaxSlider	一个滑块，允许用户指定最小值和最大值。	UnityEngine.UIElements	没有	BaseField<Vector2>所有属性 low-limit：滚动条的最小值：滚动条 high-limit的最大值 min-value：滑块光标的最小值 max-value：滑块光标的最大值
EnumField	获取底层字符串值的字段Enum。	UnityEditor.UIElements	没有	所有属性BaseField<Enum> type：表示底层的C＃类型的字符串Enum。如果类型在用户程序集中，则必须将程序集名称添加到类型名称：MyNamespace.MyEnum, MyAssembly。type始终需要该字符串。 value：表示字段值的字符串
MaskField	一个弹出菜单，用户可以从中选择一组值。	UnityEditor.UIElements	没有	BaseField<int>所有属性 choices：弹出菜单中最多显示32个选项的逗号分隔列表 value：一个整数，表示该字段的值为32位掩码。
LayerField	用户可以选择一个一个弹出式菜单层 。	UnityEditor.UIElements	没有	BaseField<int>所有属性 value：表示字段值（选定图层编号）的整数。
LayerMaskField	一个弹出菜单，用户可以从中选择一组图层。	UnityEditor.UIElements	没有	MaskField所有属性
TagField	用户可以选择标记 的弹出菜单。	UnityEditor.UIElements	没有	BaseField<string>所有属性 value：表示字段值的字符串（选定的标记名称）。
ProgressBar	显示操作进度的进度条。	UnityEditor.UIElements	没有	BindableElement所有属性 low-value：表示进度条最低值的浮点数。默认值为0  high-value.：表示进度条最高值的浮点数。默认值为100.： title表示进度条标题的字符串。

文本输入

元件	功能	命名空间	允许的子元素	属性
TextInputBaseField<TValueType>	所有文本字段的抽象基类。	UnityEngine.UIElements	没有	BaseFieldTraits<string, UxmlStringAttributeDescription>所有属性 text：字段的文本值 max-length：字段可包含的最大字符数。默认值-1设置文本长度没有限制。 password：一个布尔值，指示是否应使用该maskCharacter字符显示或显示字段内容。false是默认设置。 mask-character：当显示所述字段的内容的字符password是true。默认是角色*。 readonly：一个布尔值，表示该字段是只读的。默认值为false
TextField	可编辑的文本字段。	UnityEngine.UIElements	没有	TextInputBaseField<string>所有属性 multiline：一个布尔值，指示文本字段是否在多行上显示其文本。设置为true在多行上显示，或设置为false显示或在一行上，忽略文本中的任何换行符。false是默认值。
IntegerField	接受整数（32位）值的文本字段。	UnityEditor.UIElements	没有	BaseFieldTraits<int, UxmlIntAttributeDescription>所有属性
LongField	接受长整数（64位）值的文本字段。	UnityEditor.UIElements	没有	BaseFieldTraits<long, UxmlLongAttributeDescription>所有属性
FloatField	接受单精度浮点值的文本字段。	UnityEditor.UIElements	没有	BaseFieldTraits<float, UxmlFloatAttributeDescription>所有属性
DoubleField	接受双精度浮点值的文本字段。	UnityEditor.UIElements	没有	BaseFieldTraits<double, UxmlDoubleAttributeDescription>所有属性
Vector2Field	一组两个文本字段，接受浮点值来编辑a的值Vector2。	UnityEditor.UIElements	没有	BaseField<Vector2>所有属性 x：X坐标 y的值：Y坐标的值
Vector2IntField	一组两个文本字段，接受整数值来编辑a的值Vector2Int。	UnityEditor.UIElements	没有	BaseField<Vector2Int>所有属性 x：X坐标 y的值：Y坐标的值
Vector3Field	一组三个文本字段，接受浮点值以编辑a的值Vector3。	UnityEditor.UIElements	没有	BaseField<Vector3>所有属性 x：X坐标 y的值：Y坐标 z的值：Z坐标的值
Vector3IntField	一组三个文本字段，接受整数值来编辑a的值Vector3Int。	UnityEditor.UIElements	没有	BaseField<Vector3Int>所有属性 x：X坐标 y的值：Y坐标 z的值：Z坐标的值
Vector4Field	一组四个文本字段，接受浮点值以编辑a的值Vector4。	UnityEditor.UIElements	没有	BaseField<Vector4>所有属性 x：X坐标 y的值：Y坐标 z的值：Z坐标 w的值：W坐标的值
RectField	一组四个文本字段，它们接受浮点值以编辑矩形的值。	UnityEditor.UIElements	没有	BaseField<Rect>所有属性 x：左上角 y的值X坐标：左上角的值Y坐标 w：矩形的宽度：矩形 h的高度
RectIntField	一组四个文本字段，接受整数值以编辑矩形的值。	UnityEditor.UIElements	没有	BaseField<RectInt>所有属性 x：左上角 y的值X坐标：左上角的值Y坐标 w：矩形的宽度：矩形 h的高度
BoundsField	一组六个文本字段，它们接受浮点值以编辑边界矩形的值。	UnityEditor.UIElements	没有	BaseField<Bounds>所有属性 cx：中心X坐标 cy的值：中心Y坐标 cz的值：中心Z坐标 ex的值：范围X坐标 ey的值：范围Y坐标 ez的值：范围Z的值坐标
BoundsIntField	一组六个文本字段，它们接受整数值以编辑边界矩形的值。	UnityEditor.UIElements	没有	BaseField<BoundsInt>所有属性 px：位置X坐标 py值：位置Y坐标 pz值：位置Z坐标 sx值：大小X坐标 sy值：大小Y坐标 sz值：大小Z值坐标

复合控件

元件	功能	命名空间	允许的子元素	属性
PropertyField	用于编辑值的标签和字段。	UnityEditor.UIElements	没有	VisualElement所有属性 binding-path：此元素绑定的属性的路径 label：字段的标签
PropertyControl<int>	用于编辑类型值的标签和字段int。	UnityEditor.UIElements	没有	BaseField<int>所有属性 value-type：表示值类型的字符串 value：字段的值
PropertyControl<long>	用于编辑类型值的标签和字段long。	UnityEditor.UIElements	没有	BaseField<long>所有属性 value-type：表示值类型的字符串 value：字段的值
PropertyControl<float>	用于编辑类型值的标签和字段float。	UnityEditor.UIElements	没有	BaseField<float>所有属性 value-type：表示值类型的字符串 value：字段的值
PropertyControl<double>	用于编辑类型值的标签和字段double。	UnityEditor.UIElements	没有	所有属性BaseField<double> value-type：表示值类型的字符串 value：字段的值
PropertyControl<string>	用于编辑类型值的标签和字段string。	UnityEditor.UIElements	没有	BaseField<string>所有属性 value-type：表示值类型的字符串 value：字段的值
ColorField	颜色选择器字段。	UnityEditor.UIElements	没有	BaseFieldTraits<Color, UxmlColorAttributeDescription>所有属性 show-eye-dropper：一个布尔值，指示是否显示滴管。设置为true显示滴管，并false隐藏它。默认设置为true。 show-alpha：一个布尔值，指示是否显示alpha控件。设置为true显示控件或false隐藏它。默认设置为true。 hdr：一个布尔值，指示是否使用高动态范围颜色选择器。设置为true使用选择器。默认设置为false。
CurveField	曲线编辑器字段。	UnityEditor.UIElements	没有	BaseField<AnimationCurve>所有属性
GradientField	渐变编辑器字段。	UnityEditor.UIElements	没有	BaseField<Gradient>所有属性
ObjectField	对象选择器字段。	UnityEditor.UIElements	没有	BaseField<Object>所有属性 allow-scene-objects：一个布尔值，指示是否可以选择场景中的对象。设置为true启用对象选择或false禁用它。默认设置为true。
InspectorElement	在检查器中显示属性的元素窗口。	UnityEditor.UIElements	任意数量的VisualElement	BindableElement所有属性

工具栏

元件	功能	命名空间	允许的子元素	属性
Toolbar	用于保存工具栏 的容器项目。	UnityEditor.UIElements	任何 VisualElement	VisualElement所有属性
ToolbarButton	工具栏的按钮。	UnityEditor.UIElements	没有	Button的所有属性
ToolbarToggle	工具栏的单选按钮。	UnityEditor.UIElements	没有	Toggle所有属性
ToolbarMenu	工具栏的下拉菜单。菜单有一个向下的箭头。	UnityEditor.UIElements	没有	TextElement所有属性
ToolbarSearchField	工具栏的搜索框。	UnityEditor.UIElements	没有	VisualElement所有属性
ToolbarPopupSearchField	带有搜索选项弹出菜单的搜索框。	UnityEditor.UIElements	没有	VisualElement所有属性
ToolbarSpacer	在工具栏按钮之间插入固定数量的空白的元素。	UnityEditor.UIElements	没有	VisualElement所有属性

视图和窗口

元件	功能	命名空间	允许的子元素	属性
ListView	显示元素列表。	UnityEngine.UIElements	没有	所有属性VisualElement item-height：列表中每个项目的高度（以像素为单位）
ScrollView	可滚动视图，带有水平和垂直滚动条。	UnityEngine.UIElements	任意数量的VisualElement	所有属性VisualElement mode：滚动视图的模式。默认情况下，它设置为ScrollViewMode.Vertical show-horizontal-scroller：一个布尔值，指示是否显示水平滚动条。默认情况下，它设置为false show-vertical-scroller：一个布尔值，指示是否显示垂直滚动条。默认情况下，它设置为false horizontal-page-size：水平滚动条的页面大小值 vertical-page-size：垂直滚动条的页面大小
TreeView	用于在树层次结构中显示元素的视图。	UnityEngine.UIElements	任意数量的VisualElement	所有属性VisualElement item-height：显示的基础列表中项目的高度
PopupWindow	UIElements窗口，显示在其他内容之上。	UnityEditor.UIElements	没有	所有属性 TextElement