HelpBox

UnityEngine.UIElements 中的类

留下反馈

建议修改

描述

为用户创建一个带有消息的帮助框。有关更多信息，请参阅 UXML 元素 HelpBox。

 public class HelpBoxExample : EditorWindow
 {
     [MenuItem("Example/Help Box")]
     static void ShowWindow()
     {
         HelpBoxExample window = (HelpBoxExample)EditorWindow.GetWindow(typeof(HelpBoxExample));
         window.Show();
     }

     void OnEnable()
     {
         rootVisualElement.Add(new HelpBox("This is a help box", HelpBoxMessageType.Info));
     }
 }

静态属性

iconErrorUssClassName	此类型元素中 HelpBoxMessageType.Error 状态的 USS 类名称。
iconInfoUssClassName	此类型元素中 HelpBoxMessageType.Info 状态的 USS 类名称。
iconUssClassName	此类型元素中图像的 USS 类名称。
iconwarningUssClassName	此类型元素中 HelpBoxMessageType.Warning 状态的 USS 类名称。
labelUssClassName	此类型元素中标签的 USS 类名称。
ussClassName	此类型元素的 USS 类名称。

属性

messageType	消息类型。
text	消息文本。

构造函数

HelpBox

创建一个新的 HelpBox。

继承的成员

静态属性

disabledUssClassName

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

属性

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，表示在应用变换后但应用布局平移之前 Axis-aligned Bounding Box (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，表示应用世界变换后的 Axis-aligned Bounding Box (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	在将给定类名添加到类列表和从类列表中删除它之间切换。
TryGetBinding	获取针对提供的目标属性的绑定实例。
TryGetDataSourceContext	查询绑定对象的 dataSource 和 dataSourcePath。
TryGetLastBindingToSourceResult	返回从 UI 到数据源的绑定对象的最后一个 BindingResult。
TryGetLastBindingToUIResult	返回从数据源到 UI 的绑定对象的最后一个 BindingResult。

受保护方法

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

这里描述的某些内容是否没有按预期工作？它可能是一个 **已知问题**。请在问题跟踪器中查看 issuetracker.unity3d.com.

脚本 API

HelpBox

成功！

提交失败

描述

静态属性

属性

构造函数

继承的成员

静态属性

属性

公共方法

受保护方法