版本:Unity 6 (6000.0)
语言英语
  • C#

TextElement

UnityEngine.UIElements 中的类

/

继承自:UIElements.BindableElement

/

实现于:UnityEngine.UIElementsModule


实现接口:IExperimentalFeatures, INotifyValueChanged<T0>, ITextEdition, ITextElementExperimentalFeatures, ITextSelection

建议更改

成功!

感谢您帮助我们提高 Unity 文档的质量。虽然我们无法接受所有提交内容,但我们会阅读用户提出的每项更改建议,并在适用时进行更新。

关闭

提交失败

由于某种原因,您的更改建议无法提交。请<a>稍后再试</a>。感谢您抽出时间帮助我们提高 Unity 文档的质量。

关闭

取消

描述

如果您要声明一个显示文本的自定义 VisualElement,请使用此类作为父类。例如,ButtonLabel 使用此类作为它们的基类。有关更多信息,请参阅 UXML 元素 TextElement

静态属性

selectableUssClassName可选择文本元素的 USS 类名。
ussClassName此类型元素的 USS 类名。

属性

displayTooltipWhenElided如果为 true,则工具提示将显示省略文本的完整版本,并且如果先前已提供工具提示,则该工具提示将被覆盖。
emojiFallbackSupport指定系统在渲染文本时查找 Emoji 字符的顺序。如果启用此设置,系统将首先在全局 Emoji 回退列表中搜索 Unicode 14.0 标准中定义为 Emoji 的字符。
enableRichText如果为 false,则不会解析富文本标签。
experimental返回 TextElement 实验接口。
isElided如果文本被省略,则返回 true,否则返回 false。
parseEscapeSequences指定是否按原样显示转义序列,或者将其替换为它们代表的字符。
selection检索此 TextElement 的 ITextSelection
text要显示的文本。

构造函数

TextElement初始化并返回 TextElement 的实例。

公共方法

MeasureTextSize根据元素样式值(例如字体、字体大小、自动换行等)计算显示文本字符串所需的尺寸。

继承成员

静态属性

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

属性

binding要更新的绑定对象。
bindingPath要绑定的目标属性的路径。
canGrabFocus如果元素可以获得焦点,则返回 true。
delegatesFocus元素是否应将其焦点委托给其子元素。
focusable如果元素可以获得焦点,则为 true。
focusController返回此元素的焦点控制器。
tabIndex用于在焦点环中对可获取焦点的元素进行排序的整数。必须大于或等于零。
childCount此对象 contentContainer 中的子元素数量。
contentContainer子元素将添加到其中,通常与元素本身相同。
contentRect元素内容区域的矩形,位于元素的本地空间中。(只读)
customStyleVisualElement 的自定义样式属性访问器。(只读)
dataSource将数据源分配给此 VisualElement,它将覆盖任何继承的数据源。此数据源由所有子元素继承。
dataSourcePath从数据源到值的路径。
dataSourceType可以分配给此 VisualElement 的数据源的可能类型。此信息仅由 UI Builder 用于提供数据源路径字段的一些自动完成,当有效数据源无法在设计时指定时。
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返回一个矩阵,该矩阵累积以下操作(按顺序):-本地缩放 -本地旋转 -本地平移 -布局平移 -父 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 渲染网格并且网格数据已更改时。
放置在后面将此元素放置在其父级子元素列表中的同级元素之前。如果元素和同级元素的位置重叠,则元素将视觉上位于其同级元素的后面。
放置在前面将此元素放置在其父级子元素列表中的同级元素之后。如果元素和同级元素的位置重叠,则元素将视觉上位于其同级元素的前面。
移除从 contentContainer 层级结构中移除此子元素。
移除在从此元素的 contentContainer 中移除位于此位置的子元素。
从类列表中移除从元素的类列表中移除一个类。
从层级结构中移除从其父级层级结构中移除此元素。
发送事件将事件发送到事件处理程序。
发送到后面将此元素发送到其父级子元素列表的开头。元素将视觉上位于任何重叠的同级元素的后面。
设置绑定在目标和源之间分配绑定。
设置启用更改 VisualElement 的启用状态。禁用的 VisualElement 不会接收大多数事件。
排序重新排序此 VisualElement contentContainer 中的子元素。
在类列表中切换在将给定类名添加到类列表和从类列表中移除给定类名之间进行切换。
尝试获取绑定获取为提供的目标属性提供的绑定实例。
尝试获取数据源上下文查询绑定对象的 dataSource 和 dataSourcePath。
尝试获取到源的最后一个绑定结果返回从 UI 到数据源的绑定对象的最后一个 BindingResult。
尝试获取到 UI 的最后一个绑定结果返回从数据源到 UI 的绑定对象的最后一个 BindingResult。

受保护方法

处理事件冒泡在 BubbleUp 阶段对该元素执行逻辑,紧接在此元素的 BubbleUp 回调之前。调用 StopPropagation 将阻止在传播路径上进一步调用此方法。
处理事件向下传递在 TrickleDown 阶段对该元素执行逻辑,紧接在此元素的 TrickleDown 回调之后。调用 StopPropagation 将阻止在传播路径上进一步调用此方法。
通知属性更改通知数据绑定系统控件的属性已更改。