Version: 2020.2

Button

class in UnityEngine.UIElements

/

继承自:UIElements.TextElement

切换到手册

描述

一个可点击的按钮。

静态变量

ussClassName此类型元素的 USS 类名称。

变量

clickable此按钮的可点击的 MouseManipulator。

构造函数

Button构造一个按钮。

Events

clicked单击按钮时触发的回调。另请参阅:Clickable.clicked。
onClick已弃用。请改用 Button.clicked。

继承的成员

静态变量

ussClassName此类型元素的 USS 类名称。
disabledUssClassName本地禁用元素的 USS 类名称。

变量

binding要更新的绑定对象。
bindingPath要绑定的目标属性的路径。
canGrabFocus如果元素可以获得焦点,则返回 true。
delegatesFocus元素是否应将焦点委托给其子项。
focusable如果元素可以获得焦点,则为 true。
focusController返回此元素的焦点控制器。
tabIndex用于对焦点环中可获得焦点的元素排序的整数。必须大于或等于零。
displayTooltipWhenElidedWhen true, a tooltip displays the full version of elided text.
isElidedReturns true if text is elided, false otherwise.
text与元素关联的文本。
childCount 此对象的 contentContainer 中的子元素数
contentContainer 子元素通常添加到此元素中
customStyle返回元素的自定义样式属性访问器。
enabledInHierarchy如果 VisualElement 是在它自己的层级视图中启用,则返回 true。
enabledSelf如果 VisualElement 是本地启用,则返回 true。
experimental返回 UIElements 实验性接口。
generateVisualContent在需要(重新)生成 VisualElement 可视内容时调用。
hierarchy 访问此元素物理层级视图
pickingMode确定在 mouseEvents 或 IPanel.Pick 查询期间是否可以选取此元素。
resolvedStyle返回 VisualElement 解析的样式值。
schedule检索此 VisualElement 的 IVisualElementScheduler
style引用此元素的样式对象。
styleSheets返回一个 VisualElementStyleSheetSet,用于操作附加到此元素的样式表。
this[int] 访问此元素物理层级视图
tooltip用户将元素悬停一小段时间后显示在信息框内的文本。
usageHints提示值的组合,用于指定 VisualElement 的高级预期使用模式。 仅当 VisualElement 尚未成为 Panel 的一部分时,才可以设置此属性。一旦成为 Panel 的一部分,此属性实际上会变为只读状态,尝试更改它将抛出异常。 适当的 UsageHints 的规范会促使系统根据预期的使用模式更好地决定如何处理或加速某些操作。 请注意,这些提示不影响行为或视觉效果,而只影响面板及其内部元素的总体性能。 通常,建议始终考虑指定适当的 UsageHints,但请注意,在某些情况下(例如,由于目标平台的硬件限制),一些 UsageHints 可能会被内部忽略。
userData此属性可用于将特定于应用程序的用户数据与此 VisualElement 关联。
viewDataKey用于查看数据持久性(即树展开状态、滚动位置、缩放级别)。

公共函数

HandleEvent处理事件,通常是通过执行与事件关联的回调处理事件。
HasBubbleUpHandlers如果事件传播 BubbleUp 阶段的事件处理程序已附加到此对象,则返回 true。
HasTrickleDownHandlers如果事件传播 TrickleDown 阶段的事件处理程序已附加到此对象,则返回 true。
RegisterCallback向实例添加事件处理程序。如果已为同一阶段(TrickleDown 或 BubbleUp)注册了事件处理程序,则此方法没有效果。
SendEvent将事件发送到事件处理程序。
UnregisterCallback从此实例删除回调。
Blur通知元素释放焦点。
Focus尝试让此元素获得焦点。
MeasureTextSize根据元素样式值(如字体、字体大小、自动换行等)计算显示文本字符串所需的大小。
Add向此元素的 contentContainer 添加一个元素
BringToFront将此元素放到其父子列表的末尾。此元素将显示在所有重叠的同级元素前方。
Children从元素的 contentContainer 返回元素
Clear从此元素的 contentContainer 中删除所有子元素
Contains如果元素是此 VisualElement 的直接子级,则返回 true
ElementAt检索相应位置的子元素
EnableInClassList启用或禁用具有给定名称的类。
FindAncestorUserData向上搜索此 VisualElement 的层级视图并检索存储的 userData(如果找到)。
FindCommonAncestor查找 VisualTree 层级视图中两个 VisualElement 之间的最低共同上级
GetClasses获取此元素的类。
GetFirstAncestorOfType从此元素的父级开始向上访问层级视图,返回第一个此类型的 VisualElement
GetFirstOfType从此元素开始向上访问层级视图,返回第一个此类型的 VisualElement
IndexOf检索指定的 VisualElement 的子索引。
Insert向此元素的 contentContainer 插入一个元素
MarkDirtyRepaint在下一帧触发 VisualElement 的重绘。
PlaceBehind将此元素放在其父子列表中同级元素之前紧邻的位置。如果此元素和同级元素位置重叠,此元素将显示在其同级元素之后。
PlaceInFront将此元素放在其父子列表中同级元素之后紧邻的位置。如果此元素和同级元素位置重叠,此元素将显示在其同级元素之前。
Remove从层级视图中删除此子级
RemoveAt从此元素的 contentContainer 中删除位于此位置的子元素
RemoveFromHierarchy将此元素从其父层级视图中删除
SendEvent将事件发送到事件处理程序。
SendToBack将此元素发送到其父子列表的开始处。此元素将显示在所有重叠的同级元素之后。
SetEnabled更改 VisualElement 启用状态。禁用的 VisualElement 不接收大多数事件。
Sort重新排序来自此 VisualElement contentContainer 的子元素。
ToggleInClassList在类列表中添加和删除给定类名之间切换。