UXML 元素 TextElement

TextElement 在UI(用户界面) 允许用户与您的应用程序进行交互。Unity 目前支持三种 UI 系统。更多信息
参见术语表中显示文本。如果您创建了一个用于显示文本的自定义控件，您可以从TextElement继承它。

创建 TextElement

您可以使用 UXML 或 C# 创建 TextElement。以下 C# 示例创建了一个带有文本值和一些样式的 TextElement

var textElement = new TextElement()
{
    text = "Hello World",
    style =
    {
        fontSize = 14,
        unityFontStyleAndWeight = FontStyle.Bold,
        unityTextAlign = TextAnchor.MiddleCenter,
        color = Color.red,
        unityFontDefinition = new FontDefinition() 
        { 
            fontAsset = m_RobotoMonoRegular 
        }
    }
}

C# 基类和命名空间

C# 类：TextElement
命名空间：UnityEngine.UIElements
基类：BindableElement

成员 UXML 属性

此元素具有以下成员属性

名称	类型	描述
`display-tooltip-when-elided`	`布尔值`	如果为真，则会显示一个工具提示，其中包含省略文本的完整版本，并且如果之前已提供工具提示，则会将其覆盖。
`emoji-fallback-support`	`布尔值`	指定系统在渲染文本时查找 Emoji 字符的顺序。如果启用此设置，则会首先搜索全局 Emoji 回退列表中在 Unicode 14.0 标准中定义为 Emoji 的字符。
`enable-rich-text`	`布尔值`	如果为假，则不会解析富文本标签。
`parse-escape-sequences`	`布尔值`	指定是否按原样显示转义序列，或者是否将其替换为它们表示的字符。
`text`	`字符串`	要显示的文本。更改此值将隐式调用`INotifyValueChanged_1.value`设置器，这将引发类型为字符串的`ChangeEvent_1`。

继承的 UXML 属性

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

名称	类型	描述
`binding-path`	`字符串`	要绑定的目标属性的路径。
`focusable`	`布尔值`	如果元素可以获得焦点，则为真。
`tabindex`	`int`	用于在焦点环中对可聚焦元素进行排序的整数。必须大于或等于零。

此元素还从VisualElement继承以下属性

名称	类型	描述
`content-container`	`字符串`	子元素添加到其中，通常与元素本身相同。
`data-source`	`对象`	为该 VisualElement 分配一个数据源，该数据源覆盖任何继承的数据源。此数据源由所有子项继承。
`data-source-path`	`字符串`	从数据源到值的路径。
`data-source-type`	`System.Type`	可分配给此 VisualElement 的数据源的可能类型。此信息仅由 UI Builder 用作提示，以便在设计时无法指定有效数据源时为数据源路径字段提供一些自动完成。
`language-direction`	`UIElements.LanguageDirection`	指示元素文本的方向性。该值将传播到元素的子项。将 languageDirection 设置为 RTL 通过反转文本并适当地处理换行和断词来添加对从右到左 (RTL) 的基本支持。但是，它不提供全面的 RTL 支持，因为这需要文本整形，包括字符的重新排序和 OpenType 字体功能支持。全面的 RTL 支持计划在将来的更新中提供，这将涉及其他 API 来处理语言、脚本和字体功能规范。为了增强此属性的 RTL 功能，用户可以探索 Unity Asset Store 中可用的第三方插件，并使用`ITextElementExperimentalFeatures.renderedText`
`name`	`字符串`	此 VisualElement 的名称。使用此属性编写针对特定元素的 USS 选择器。标准做法是为元素提供唯一的名称。
`picking-mode`	`UIElements.PickingMode`	确定在鼠标事件或`IPanel.Pick`查询期间是否可以选择此元素。
`style`	`字符串`	设置`VisualElement`样式值。
`tooltip`	`字符串`	在用户将鼠标悬停在元素上一小段时间后，在信息框内显示的文本。这仅在编辑器 UI 中受支持。
`usage-hints`	`UIElements.UsageHints`	指定`VisualElement`的高级预期使用模式的提示值组合。仅当`VisualElement`尚未成为`Panel`的一部分时，才能设置此属性。一旦成为`Panel`的一部分，此属性实际上就成为只读属性，尝试更改它将引发异常。正确`UsageHints`的规范会驱动系统做出更好的决策，以根据预期的使用模式处理或加速某些操作。请注意，这些提示不会影响行为或视觉结果，只会影响面板及其内部元素的整体性能。建议始终考虑指定正确的`UsageHints`，但请记住，在某些情况下，某些`UsageHints`可能会在内部被忽略（例如，由于目标平台上的硬件限制）。
`view-data-key`	`字符串`	用于视图数据持久性，例如树展开状态、滚动位置或缩放级别。此键用于从视图数据存储中保存和加载视图数据。如果您不设置此键，则关联的`VisualElement`的持久性将被禁用。有关更多信息，请参阅视图数据持久性。

USS 类

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

C# 属性	USS 选择器	描述
`ussClassName`	`.unity-text-element`	此类型元素的 USS 类名称。
`selectableUssClassName`	`.unity-text-element__selectable`	可选文本元素的 USS 类名称。
`disabledUssClassName`	`.unity-disabled`	本地禁用元素的 USS 类名称。

您还可以使用检查器或 UI 工具包调试器中的匹配选择器部分来查看哪些 USS 选择器影响其层次结构中每个级别的VisualElement的组件。

其他资源

UXML 元素 TagField

UXML 元素 TextField