BaseField<T0>

UnityEngine.UIElements 类

留下反馈

实现接口: IMixedValueSupport, INotifyValueChanged<T0>

建议修改

描述

用于控件的抽象基类。

BaseField 是用于字段元素（如 TextField 和 IntegerField）的基类。要将 BaseField 元素自动与 Inspector 窗口中的其他字段对齐，请使用 .unity-base-field__aligned USS 类。此样式类专为 Inspector 元素（如 PropertyField）设计，后者默认情况下具有该样式类。但是，如果您手动将子 BaseField 元素添加到 PropertyField，则必须手动添加样式类。

存在样式类时，字段会自动计算标签宽度，以与 Inspector 窗口中的其他字段对齐。如果存在 IMGUI 字段，则 UI 工具包字段会与它们对齐，以确保一致性和兼容性。

静态属性

alignedFieldUssClassName	在 Inspector 元素中对齐的元素的 USS 类名
inputUssClassName	此类型元素中的输入元素的 USS 类名。
labelDraggerVariantUssClassName	此类型元素中标签的 USS 类名，当标签上附加了拖动器时。
labelUssClassName	此类型元素中标签的 USS 类名。
mixedValueLabelUssClassName	显示混合值的元素的 USS 类名
noLabelVariantUssClassName	此类型元素的 USS 类名，当没有标签时。
ussClassName	此类型元素的 USS 类名。

属性

label	表示将出现在字段旁边的标签的字符串。
labelElement	这是出现在字段输入旁边的标签对象。
mixedValueLabel	用于呈现编辑多个不同值的显示的只读标签。
rawValue	元素的值。
showMixedValue	设置为 true 时，会使字段呈现编辑多个不同值的显示。
value	与字段关联的值。

公共方法

SetValueWithoutNotify

允许设置值，而不必在出现任何更改时收到通知。

受保护的方法

UpdateMixedValueContent

根据 showMixedValue 更新字段的视觉内容。

继承的成员

静态属性

disabledUssClassName

本地禁用元素的 USS 类名。

属性

binding	将要更新的绑定对象。
bindingPath	要绑定的目标属性的路径。
canGrabFocus	如果元素可以获得焦点，则返回 true。
delegatesFocus	元素是否应将其子元素的焦点委托给其子元素。
focusable	如果元素可以获得焦点，则为 true。
focusController	返回此元素的焦点控制器。
tabIndex	用于在焦点环中对可获得焦点的元素进行排序的整数。必须大于或等于零。
childCount	此对象 contentContainer 中的子元素数量。
contentContainer	子元素将添加到其中，通常与元素本身相同。
contentRect	元素内容区域的矩形，位于元素的本地空间中。（只读）
customStyle	VisualElement 的自定义样式属性访问器。（只读）
dataSource	将数据源分配给此 VisualElement，该数据源会覆盖任何继承的数据源。此数据源由所有子元素继承。
dataSourcePath	从数据源到值的路径。
dataSourceType	可以分配给此 VisualElement 的数据源的可能类型。此信息仅由 UI 生成器使用，作为提示，以便在设计时无法指定有效数据源时为数据源路径字段提供一些完成。
disablePlayModeTint	默认情况下会应用播放模式色调，除非将其设置为 true。它会按层次结构应用于此 VisualElement 以及存在于编辑器面板上的所有子元素。
enabledInHierarchy	如果 VisualElement 在其自身层次结构中启用，则返回 true。
enabledSelf	如果 VisualElement 在本地启用，则返回 true。
experimental	返回 UIElements 实验性接口。
generateVisualContent	用于生成视觉元素的视觉内容的委托函数。
hierarchy	访问此元素的物理层次结构
languageDirection	指示元素文本的方向。该值将传播到元素的子元素。
layout	相对于其父元素的 VisualElement 的位置和大小，由布局系统计算。（只读）
localBound	返回一个 Rect，表示应用变换后但应用布局平移之前的轴对齐包围盒 (AABB)。
name	此 VisualElement 的名称。
paddingRect	元素填充区域的矩形，位于元素的本地空间中。
panel	附加此 VisualElement 的面板。
parent	此 VisualElement 的父元素。
pickingMode	确定此元素是否可以在鼠标事件或 IPanel.Pick 查询期间被拾取。
resolvedStyle	视觉元素的最终渲染样式值，如当前帧中渲染的样式值。（只读）
scaledPixelsPerPoint	返回来自面板的结果缩放比例，该缩放比例考虑屏幕 DPI 和可自定义的缩放系数，但不考虑元素及其祖先的变换缩放比例。请参阅 Panel.scaledPixelsPerPoint。这应该只对面板中的一部分元素调用。
schedule	检索此 VisualElement 的 IVisualElementScheduler
style	设置 VisualElement 上的样式值。
styleSheets	返回一个 VisualElementStyleSheetSet，用于操作附加到此元素的样式表。
this[int]	检索特定索引处的子元素。
tooltip	在用户将鼠标悬停在元素上一段时间后，要在信息框内显示的文本。这仅在编辑器 UI 中受支持。
transform	返回此 VisualElement 的变换对象。ITransform
usageHints	指定 VisualElement 的高级预期使用模式的提示值组合。此属性只能在 VisualElement 尚未成为面板的一部分时设置。一旦成为面板的一部分，此属性将实际上变为只读，尝试更改它将引发异常。正确 UsageHints 的指定驱动系统，根据预期的使用模式做出更好的决策，以处理或加速某些操作。请注意，这些提示不会影响行为或视觉结果，只会影响面板和其中元素的整体性能。建议始终考虑指定正确的 UsageHints，但请记住，在某些条件下（例如，由于目标平台上的硬件限制），某些 UsageHints 可能会在内部被忽略。
userData	此属性可用于将特定于应用程序的用户数据与此 VisualElement 关联。
viewDataKey	用于视图数据持久性，例如树展开状态、滚动位置或缩放级别。
visible	指示此元素是否应呈现。
visualTreeAssetSource	存储资产引用，如果生成的元素是从 VisualTreeAsset 克隆的。
worldBound	返回一个 Rect，表示应用世界变换后的轴对齐包围盒 (AABB)。
worldTransform	返回一个矩阵，该矩阵累积以下操作（按顺序）： -本地缩放 -本地旋转 -本地平移 -布局平移 -父世界变换（递归定义 - 在没有父元素时考虑身份）

公共方法

HasBubbleUpHandlers	如果事件传播的 BubbleUp 阶段的事件处理程序已附加到此对象，则返回 true。
HasTrickleDownHandlers	如果事件传播的 TrickleDown 阶段的事件处理程序已附加到此对象，则返回 true。
RegisterCallback	将事件处理程序添加到实例。如果事件处理程序已为同一阶段（TrickleDown 或 BubbleUp）注册，则此方法无效。
RegisterCallbackOnce	将事件处理程序添加到实例。如果事件处理程序已为同一阶段（TrickleDown 或 BubbleUp）注册，则此方法无效。事件处理程序在恰好被调用一次后会自动取消注册。
UnregisterCallback	从实例中删除回调。
Blur	告诉元素释放焦点。
Focus	尝试将焦点赋予此元素。
Add	将元素添加到此元素的 contentContainer
AddToClassList	将类添加到元素的类列表中，以从 USS 分配样式。请注意，类名区分大小写。
BringToFront	将此元素移至其父元素的子元素列表的末尾。该元素将在视觉上位于任何重叠的同级元素的前面。
Children	返回其 contentContainer 中的元素。
ClassListContains	在该元素的类列表中搜索类。
Clear	从此元素的 contentContainer 中删除所有子元素
ClearBinding	从元素中删除绑定。
ClearBindings	从元素中删除所有绑定。
ClearClassList	从该元素的类列表中删除所有类。AddToClassList
Contains	检查此元素是否为指定子元素的祖先。
ContainsPoint	检查指定点是否与此 VisualElement 的布局相交。
ElementAt	检索特定索引处的子元素。
EnableInClassList	启用或禁用具有给定名称的类。
FindAncestorUserData	向上搜索此 VisualElement 的层次结构，并检索存储的 userData（如果有）。
FindCommonAncestor	在 VisualTree 层次结构中查找两个 VisualElement 之间的最低共同祖先。
GetBinding	获取为提供的目标属性提供的绑定实例。
GetBindingInfos	获取当前元素的所有绑定的信息。
GetClasses	检索此元素的类。
GetDataSourceContext	查询绑定的数据源和 dataSourcePath 对象。
GetFirstAncestorOfType	向上遍历层次结构，从该元素的父元素开始，并返回此类型的第一个 VisualElement
GetFirstOfType	向上遍历层次结构，从该元素开始，并返回此类型的第一个 VisualElement
GetHierarchicalDataSourceContext	查询从层次结构继承的 dataSource 和 dataSourcePath。
HasBinding	允许知道目标属性是否与其关联的绑定。
IndexOf	检索指定 VisualElement 的子索引。
Insert	将元素插入到此元素的 contentContainer 中
MarkDirtyRepaint	在下一帧重新绘制 VisualElement。当发生需要重新绘制的更改时，此方法会在内部调用，例如当 UIElements.BaseField_1.value 发生更改或 Label 中的文本发生更改时。如果您正在实现自定义控件，则可以在发生需要重新绘制的更改时调用此方法以触发重新绘制，例如当使用 generateVisualContent 渲染网格并且网格数据现在已更改时。
PlaceBehind	将此元素放置在其父级子级列表中同级元素的正前方。如果元素和同级元素的位置重叠，则元素将在视觉上位于其同级元素的后面。
PlaceInFront	将此元素放置在其父级子级列表中同级元素的正后方。如果元素和同级元素的位置重叠，则元素将在视觉上位于其同级元素的前面。
Remove	从 contentContainer 层次结构中删除此子元素。
RemoveAt	从此元素的 contentContainer 中删除位于此位置的子元素。
RemoveFromClassList	从元素的类列表中删除一个类。
RemoveFromHierarchy	从其父级层次结构中删除此元素。
SendEvent	向事件处理程序发送一个事件。
SendToBack	将此元素发送到其父级子级列表的开头。该元素将在视觉上位于任何重叠的同级元素的后面。
SetBinding	在目标和源之间分配绑定。
SetEnabled	更改 VisualElement 的启用状态。禁用的 VisualElement 不会接收大多数事件。
Sort	重新排序来自此 VisualElement contentContainer 的子元素。
ToggleInClassList	在将给定类名添加到类列表和从类列表中删除给定类名之间切换。
TryGetBinding	获取为提供的目标属性提供的绑定实例。
TryGetDataSourceContext	查询绑定的数据源和 dataSourcePath 对象。
TryGetLastBindingToSourceResult	返回从 UI 到数据源的绑定对象的最后一个 BindingResult。
TryGetLastBindingToUIResult	返回从数据源到 UI 的绑定对象的最后一个 BindingResult。

受保护的方法

HandleEventBubbleUp	在 BubbleUp 阶段在此元素上执行逻辑，紧接在此元素的 BubbleUp 回调之前。调用 StopPropagation 将阻止沿传播路径进一步调用此方法。
HandleEventTrickleDown	在 TrickleDown 阶段在此元素上执行逻辑，紧接在此元素的 TrickleDown 回调之后。调用 StopPropagation 将阻止沿传播路径进一步调用此方法。
NotifyPropertyChanged	通知数据绑定系统控件的属性已更改。

此处描述的某些内容是否未按预期工作？这可能是已知问题。请在问题跟踪器中查看 issuetracker.unity3d.com.

脚本 API

BaseField<T0>

成功！

提交失败

描述

静态属性

属性

公共方法

受保护的方法

继承的成员

静态属性

属性

公共方法

受保护的方法