版本:Unity 6 (6000.0)
语言英语
  • C#

PropertyField

UnityEditor.UIElements 中的类

/

继承自:UIElements.VisualElement


实现接口:IBindable

建议更改

成功!

感谢您帮助我们提高 Unity 文档的质量。虽然我们无法接受所有提交的内容,但我们确实会阅读用户提出的每项建议的更改,并在适用时进行更新。

关闭

提交失败

由于某些原因,您的建议更改无法提交。请<a>稍后再试</a>。感谢您抽出时间帮助我们提高 Unity 文档的质量。

关闭

取消

描述

一个 SerializedProperty 包装的 VisualElement,在 Bind() 时,它将生成具有正确绑定路径的正确字段元素。有关更多信息,请参阅 UXML 元素 PropertyField

静态属性

inputUssClassName此类型元素中输入元素的 USS 类名。
inspectorElementUssClassName检查器元素中属性字段的 USS 类名
labelUssClassName此类型元素中标签的 USS 类名。
ussClassName此类型元素的 USS 类名。

属性

binding将要更新的绑定对象。
bindingPath要绑定的目标属性的路径。
label可以选择覆盖生成的属性字段的标签。如果没有提供标签,则字符串将从 SerializedProperty 获取。

构造函数

PropertyFieldPropertyField 构造函数。

公共方法

RegisterValueChangeCallback注册此回调以在值更改时接收 SerializedPropertyChangeEvent。

继承的成员

静态属性

disabledUssClassName本地禁用元素的 USS 类名。

属性

canGrabFocus如果元素可以获得焦点,则返回 true。
delegatesFocus元素是否应将其焦点委托给其子元素。
focusable如果元素可以获得焦点,则为 true。
focusController返回此元素的焦点控制器。
tabIndex用于在焦点环中对可聚焦元素进行排序的整数。必须大于或等于零。
childCount此对象 contentContainer 中的子元素数量。
contentContainer子元素被添加到其中,通常与元素本身相同。
contentRect元素内容区域的矩形,位于元素的本地空间中。(只读)
customStyleVisualElement 的自定义样式属性访问器。(只读)
dataSource将数据源分配给此 VisualElement,它将覆盖任何继承的数据源。此数据源由所有子元素继承。
dataSourcePath从数据源到值的路径。
dataSourceType可以分配给此 VisualElement 的数据源的可能类型。此信息仅由 UI Builder 使用,作为提示,在设计时无法指定有效数据源时,为数据源路径字段提供一些补全。
disablePlayModeTint默认情况下会应用播放模式色调,除非将其设置为 true。它将分层应用于此 VisualElement 及其在编辑器面板上存在的所有子元素。
enabledInHierarchy如果 VisualElement 在其自身层次结构中启用,则返回 true。
enabledSelf如果 VisualElement 在本地启用,则返回 true。
experimental返回 UIElements 实验性接口。
generateVisualContent用于生成视觉元素的视觉内容的委托函数。
hierarchy访问此元素的物理层次结构
languageDirection指示元素文本的方向。该值将传播到元素的子元素。
layoutVisualElement 相对于其父元素的位置和大小,由布局系统计算。(只读)
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 尚未成为 Panel 的一部分时设置。一旦成为 Panel 的一部分,此属性将有效地变为只读,尝试更改它将抛出异常。正确 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查询绑定对象的 dataSource 和 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在类列表中添加或删除给定类名。
尝试获取绑定获取为提供的目标属性提供的绑定实例。
尝试获取数据源上下文查询绑定对象的 dataSource 和 dataSourcePath。
尝试获取最后绑定到源的结果返回从 UI 到数据源的绑定对象的最后一个 BindingResult。
尝试获取最后绑定到 UI 的结果返回从数据源到 UI 的绑定对象的最后一个 BindingResult。

受保护的方法

处理事件冒泡在此元素的 BubbleUp 回调之前,立即在该元素的 BubbleUp 阶段执行逻辑。调用 StopPropagation 将阻止在此传播路径上的此方法的进一步调用。
处理事件向下传递在此元素的 TrickleDown 回调之后,立即在该元素的 TrickleDown 阶段执行逻辑。调用 StopPropagation 将阻止在此传播路径上的此方法的进一步调用。
通知属性更改通知数据绑定系统控件的属性已更改。