帮助箱

帮助框向用户显示一条消息。您可以设置要显示的消息类型，例如警告或错误。您还可以将消息设置为显示为富文本。

创建帮助箱

你可以使用 UXML 和 C# 创建帮助框。以下 C# 示例创建一个 HelpBox，其中包含消息“帮助文本”和信息图标：

HelpBox helpBox = new HelpBox("Help text", HelpBoxMessageType.Info);

例

以下UXML示例创建了一个带有警告消息的帮助框：

<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements">
    <HelpBox text="UXML Help Box" message-type="Info" name="the-uxml-help-box" />
</UXML>

以下 C# 示例演示了帮助框的一些可自定义功能：

/// <sample>
// Get a reference to the help box from UXML and update its text.
var uxmlHelpBox = container.Q<HelpBox>("the-uxml-help-box");
uxmlHelpBox.text += " (Updated in C#)";

// Create a new help box and give it a style class.
var csharpHelpBox = new HelpBox("This is a help box", HelpBoxMessageType.Warning);
csharpHelpBox.AddToClassList("some-styled-help-box");
container.Add(csharpHelpBox);
/// </sample>

若要在 Unity 中实时试用此示例，请转到 Window > UI 工具包>示例。

C# 基类和命名空间

C# 类：HelpBox
命名空间：UnityEngine.UIElements
基类：VisualElement

成员 UXML 属性

此元素具有以下成员属性：

名字	类型	描述
`message-type`	`UIElements.HelpBoxMessageType`	消息的类型。
`text`	`string`	消息文本。

继承的UXML属性

此元素从其基类继承以下属性：

名字	类型	描述
`focusable`	`boolean`	如果为 false，则阻止对元素进行聚焦。仅当元素的 canGrabFocus 属性为 true 时，才能对元素进行聚焦。
`tabindex`	`int`	用于对焦点环中的可聚焦元素进行排序的整数。必须大于或等于零。将`tabIndex`值小于`0`（例如，`−1`）从焦点环和选项卡导航中删除元素。

此元素还继承了以下属性VisualElement:

名字	类型	描述
`content-container`	`string`	添加子元素的逻辑容器。如果将子元素添加到此元素，则将子元素添加到该元素的内容容器中。当迭代`VisualElement.Children`元素的元素，则使用元素的内容容器层次结构而不是元素本身。这可能会导致意外结果，例如，如果元素不直接位于内容容器的层次结构中，则导航事件会忽略元素。指`IFocusRing`了解更多信息。如果内容容器与元素本身相同，则子元素将直接添加到元素中。对于大多数元素来说都是如此，但可以被更复杂的类型覆盖。这`ScrollView`例如，具有与自身不同的内容容器。在这种情况下，添加到滚动视图的子元素将改为添加到其内容容器元素中。虽然物理父级（`VisualElement.Hierarchy.parent`）是滚动视图的内容容器元素，它们的逻辑父元素（`VisualElement.parent`）仍然引用滚动视图本身。由于滚动视图的一些可聚焦子项不是其逻辑层次结构的一部分，例如`Scroller`元素，在使用顺序导航时，默认情况下不考虑这些可聚焦的子项。如果默认导航规则与您的需求不符，请参阅如何更改接下来关注的元素，了解解决方法解决方案的示例。
`data-source`	`Object`	将数据源分配给此 VisualElement，该 VisualElement 将替代任何继承的数据源。此数据源由所有子级继承。
`data-source-path`	`string`	从数据源到值的路径。
`data-source-type`	`System.Type`	可分配给此 VisualElement 的可能数据源类型。当设计时无法指定有效数据源时，UI 生成器仅将此信息用作提示，以对数据源路径字段进行一些补全。
`enabled`	`boolean`	如果`VisualElement`在本地启用。如果 VisualElement 的父级之一隐式禁用，则不会更改此标志。要验证这一点，请使用`enabledInHierarchy`.
`language-direction`	`UIElements.LanguageDirection`	指示元素文本的方向性。该值将传播到元素的子项。设置`languageDirection`自`RTL`只能获得文本反转等基本的 RTL 支持。要获得更全面的 RTL 支持，例如换行、自动换行或文本整形，您必须启用高级文本生成器。
`name`	`string`	此 VisualElement 的名称。使用此属性可以编写面向特定元素的 USS 选择器。标准做法是为元素指定一个唯一的名称。
`picking-mode`	`UIElements.PickingMode`	确定此元素是可以作为指针事件的目标还是由`IPanel.Pick`查询。如果出现以下情况，则无法拾取元素： - 它们不可见- 它们的`style.display`设置为`DisplayStyle.None` 拾取模式为`PickingMode.Ignore`永远不要接收悬停伪状态。
`style`	`string`	在`VisualElement`. 返回的样式数据是根据 USS 文件或在 C# 中写入此对象的内联样式计算得出的，不表示完全解析的样式，例如 VisualElement 的最终高度和宽度。要访问这些完全解析的样式，请使用`resolvedStyle`. 有关如何使用此属性和所有受支持的 USS 属性的信息，请参阅在 C# 脚本中应用样式和 USS 属性参考手册页。
`tooltip`	`string`	用户将鼠标悬停在元素上一小段时间后，要在信息框内显示的文本。这仅在编辑器UI中受支持。
`usage-hints`	`UIElements.UsageHints`	提示值的组合，用于指定`VisualElement`.只有当`VisualElement`还不是`Panel`.曾经是`Panel`，则此属性实际上变为只读，尝试更改它将引发异常。适当的规范`UsageHints`驱动系统根据预期的使用模式就如何处理或加速某些作做出更好的决策。请注意，这些提示不会影响行为或视觉结果，而只会影响面板和其中元素的整体性能。建议始终考虑指定适当的`UsageHints`，但请记住，某些`UsageHints`在某些情况下（例如，由于目标平台上的硬件限制），可能会在内部忽略。
`view-data-key`	`string`	用于视图数据持久性，例如树展开状态、滚动位置或缩放级别。此键用于从视图数据存储中保存和加载视图数据。如果未设置此键，则会禁用关联的持久性`VisualElement`.有关更多信息，请参阅 Unity 手册中的查看数据持久性。

USS 级

下表列出了所有 C# 公共属性名称及其相关的 USS 选择器。

C# 属性	USS 选择器	描述
`ussClassName`	`.unity-help-box`	此类型元素的 USS 类名称。
`labelUssClassName`	`.unity-help-box__label`	此类型元素中标注的 USS 类名称。
`iconUssClassName`	`.unity-help-box__icon`	此类型元素中图像的 USS 类名称。
`iconInfoUssClassName`	`.unity-help-box__icon--info`	USS 的 USS 级名称`HelpBoxMessageType.Info`state 中的 Elements of this 类型的元素。
`iconwarningUssClassName`	`.unity-help-box__icon--warning`	USS 的 USS 级名称`HelpBoxMessageType.Warning`state 中的 Elements of this 类型的元素。
`iconErrorUssClassName`	`.unity-help-box__icon--error`	USS 的 USS 级名称`HelpBoxMessageType.Error`state 中的 Elements of this 类型的元素。
`disabledUssClassName`	`.unity-disabled`	本地禁用元素的 USS 级名称。

您还可以使用 Inspector 或 UI Toolkit Debugger 中的 Matching Selectors 部分来查看哪些 USS 选择器会影响VisualElement在其层次结构的各个层面。

其他资源

使用文本

Hash128字段

IMGUI连接器

手册

帮助箱