这是一个可点击的按钮。
Button 具有一个文本标签元素,该元素可以响应指针和鼠标事件。您可以通过将背景(纹理、RenderTexture、Sprite 或矢量图像)分配给 iconImage API 或 icon-image UXML 属性,添加一个图标与其文本配对。请注意,提供图标图像将自动更新 Button 的层次结构以包含一个Image 和一个文本标签元素。
默认情况下,单击鼠标左键一次会激活 Button 的Clickable 属性按钮。若要删除此激活器或添加更多激活器,请修改clickable.activators 属性。有关详细信息,请参阅 ManipulatorActivationFilter。
若要将 Button 的文本值绑定到变量的内容,请在 UXML 文件中将binding-path 属性或在 C# 代码中将bindingPath 属性设置为包含变量名的字符串。
有关更多信息,请参阅 UXML 元素 Button。
| iconOnlyUssClassName | 仅包含图标、没有文本的 Button 元素的 USS 类名。 |
| iconUssClassName | 包含图标的 Button 元素的 USS 类名。 |
| imageUSSClassName | 将用于显示图标纹理的图像元素的 USS 类名。 |
| ussClassName | 此类型元素的 USS 类名。 |
| clickable | 此 Button 的 Clickable MouseManipulator。 |
| iconImage | 将代表 Button 元素内图标的 Texture、Sprite 或 VectorImage。 |
| Button | 构造 Button。 |
| selectableUssClassName | 可选择的文本元素的 USS 类名。 |
| ussClassName | 此类型元素的 USS 类名。 |
| disabledUssClassName | 本地禁用元素的 USS 类名。 |
| binding | 将更新的绑定对象。 |
| bindingPath | 要绑定的目标属性的路径。 |
| canGrabFocus | 如果元素可以获得焦点,则返回 true。 |
| delegatesFocus | 元素是否应将焦点委派给其子元素。 |
| focusable | 如果元素可以获得焦点,则为 true。 |
| focusController | 返回此元素的焦点控制器。 |
| tabIndex | 用于在焦点环中对可获得焦点的元素进行排序的整数。必须大于或等于零。 |
| displayTooltipWhenElided | 如果为 true,则工具提示会显示省略文本的完整版本,并且如果之前提供了工具提示,它将被覆盖。 |
| emojiFallbackSupport | 指定系统在呈现文本时查找 Emoji 字符的顺序。如果启用此设置,系统将首先在全局 Emoji 回退列表中搜索在 Unicode 14.0 标准中定义为 Emoji 的字符。 |
| enableRichText | 如果为 false,则不会解析富文本标签。 |
| experimental | 返回 TextElement 实验接口。 |
| isElided | 如果文本被省略,则返回 true,否则返回 false。 |
| parseEscapeSequences | 指定转义序列按原样显示还是被替换为它们代表的字符。 |
| selection | 检索此 TextElement 的 ITextSelection |
| text | 要显示的文本。 |
| childCount | 此对象 contentContainer 中的子元素数量。 |
| contentContainer | 子元素将被添加到其中,通常与元素本身相同。 |
| contentRect | 元素内容区域的矩形,在元素的本地空间中。(只读) |
| customStyle | VisualElement 的自定义样式属性访问器(只读)。 |
| dataSource | 将数据源分配给此 VisualElement,该数据源会覆盖任何继承的数据源。此数据源由所有子元素继承。 |
| dataSourcePath | 从数据源到值的路径。 |
| dataSourceType | 可以分配给此 VisualElement 的数据源的可能类型。此信息仅由 UI Builder 用作提示,以便在设计时无法指定有效数据源时,为数据源路径字段提供一些完成。 |
| disablePlayModeTint | 除非将此设置为 true,否则默认情况下会应用播放模式色调。它会以层次结构方式应用于此 VisualElement 及其在编辑器面板上存在的所有子元素。 |
| enabledInHierarchy | 如果 VisualElement 在其自己的层次结构中启用,则返回 true。 |
| enabledSelf | 如果 VisualElement 在本地启用,则返回 true。 |
| 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 | 尝试将焦点赋予此元素。 |
| MeasureTextSize | 根据元素样式值(例如字体、字体大小、自动换行等)计算显示文本字符串所需的尺寸。 |
| 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 | 在将给定类名添加到类列表和从类列表中移除给定类名之间切换。 |
| TryGetBinding | 获取为提供的目标属性提供的绑定实例。 |
| TryGetDataSourceContext | 查询绑定对象的 dataSource 和 dataSourcePath。 |
| TryGetLastBindingToSourceResult | 返回从 UI 到数据源的绑定对象的最后一个 BindingResult。 |
| TryGetLastBindingToUIResult | 返回从数据源到 UI 的绑定对象的最后一个 BindingResult。 |
| HandleEventBubbleUp | 在 BubbleUp 阶段在此元素上执行逻辑,紧接在此元素的 BubbleUp 回调之前。调用 StopPropagation 将阻止在此传播路径上进一步调用此方法。 |
| HandleEventTrickleDown | 在 TrickleDown 阶段在此元素上执行逻辑,紧接在此元素的 TrickleDown 回调之后。调用 StopPropagation 将阻止在此传播路径上进一步调用此方法。 |
| NotifyPropertyChanged | 通知数据绑定系统控件的属性已更改。 |