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

MaskField

UnityEditor.UIElements 中的类

/

继承自: UIElements.BaseMaskField_1

建议更改

成功!

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

关闭

提交失败

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

关闭

取消

描述

创建用于遮罩的字段。

静态属性

inputUssClassName此类型元素中输入元素的 USS 类名称。
labelUssClassName此类型元素中标签的 USS 类名称。
ussClassName此类型元素的 USS 类名称。

属性

formatListItemCallback用于填充弹出菜单的字符串表示的回调。
formatSelectedValueCallback用于显示所选值的字符串表示的回调。

构造函数

MaskField初始化并返回 MaskField 的实例。

继承的成员

静态属性

alignedFieldUssClassName在检查器元素中对齐的元素的 USS 类名称
labelDraggerVariantUssClassName此类型元素中标签的 USS 类名称,当标签附加了拖动器时。
mixedValueLabelUssClassName显示混合值的元素的 USS 类名称
noLabelVariantUssClassName此类型元素的 USS 类名称,当没有标签时。
arrowUssClassName此类型元素中箭头指示器的 USS 类名称。
inputUssClassName此类型元素中输入元素的 USS 类名称。
labelUssClassName此类型元素中标签的 USS 类名称。
textUssClassName此类型元素中文本元素的 USS 类名称。
ussClassName此类型元素的 USS 类名称。
disabledUssClassName本地禁用元素的 USS 类名称。

属性

label表示将在字段旁边显示的标签的字符串。
labelElement这是出现在字段输入旁边的 Label 对象。
mixedValueLabel用于提供编辑多个不同值的显示的只读标签。
rawValue元素的值。
showMixedValue设置为 true 时,将使字段呈现编辑多个不同值的显示。
value与字段关联的值。
choices要显示在弹出菜单中的选项列表。
choicesMasks要显示在弹出菜单中的每个特定选项的遮罩列表。
choices要显示在弹出菜单中的选项列表。
text这是向用户显示的当前弹出窗口选择的文本。
textElement这是显示的文本。
binding将要更新的绑定对象。
bindingPath要绑定的目标属性的路径。
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 尚未成为面板的一部分时设置。一旦成为面板的一部分,此属性将变为有效只读,尝试更改它将引发异常。正确 UsageHints 的规范驱动系统根据预期的使用模式,就如何处理或加速某些操作做出更好的决策。请注意,这些提示不会影响行为或视觉结果,只会影响面板及其内部元素的整体性能。建议始终考虑指定正确的 UsageHints,但请记住,某些 UsageHints 在某些情况下可能会被内部忽略 (例如,由于目标平台上的硬件限制)。
userData此属性可用于将特定于应用程序的用户数据与此 VisualElement 关联。
viewDataKey用于视图数据持久性,例如树展开状态、滚动位置或缩放级别。
visible指示是否应渲染此元素。
visualTreeAssetSource存储资产引用,如果生成的元素是从 VisualTreeAsset 克隆的。
worldBound返回一个 Rect,表示应用世界变换后的轴对齐边界框 (AABB)。
worldTransform返回一个矩阵,该矩阵累积以下操作 (按顺序): -本地缩放 -本地旋转 -本地平移 -布局平移 -父级 worldTransform (递归定义 - 如果没有父级,请考虑恒等式)

公共方法

SetValueWithoutNotify允许更改值而不触发任何更改事件。
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 层次结构中两个 VisualElements 之间的最低公共祖先。
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在将给定类名添加到类列表中和从类列表中删除给定类名之间切换。
TryGetBinding获取为提供的目标属性提供的绑定实例。
TryGetDataSourceContext查询绑定对象的 dataSource 和 dataSourcePath。
TryGetLastBindingToSourceResult返回 UI 到数据源的绑定对象的最后一个 BindingResult。
TryGetLastBindingToUIResult返回数据源到 UI 的绑定对象的最后一个 BindingResult。

受保护的方法

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