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

TextValueField<T0>

UnityEngine.UIElements 中的类

/

继承自:UIElements.TextInputBaseField_1

/

在以下文件中实现:UnityEngine.UIElementsModule


实现接口:IValueField<T0>

建议更改

成功!

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

关闭

提交失败

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

关闭

取消

描述

文本字段的基类。

属性

formatString值的格式字符串。

公共方法

ApplyInputDeviceDelta应用来自输入设备的 3D 偏移量和速度的值。
SetValueWithoutNotify允许设置值而不发出通知。
StartDragging指示用户开始鼠标拖动以进行文本选择。
StopDragging指示用户停止鼠标拖动以进行文本选择。

受保护的方法

AddLabelDragger用于在特定数字字段的标签上添加鼠标拖动器的方法。

继承的成员

静态属性

alignedFieldUssClassName在检查器元素中对齐的元素的 USS 类名
labelDraggerVariantUssClassName此类型元素中标签的 USS 类名,当这些标签上附加了拖动器时。
mixedValueLabelUssClassName显示混合值的元素的 USS 类名
noLabelVariantUssClassName此类型元素的 USS 类名,当没有标签时。
inputUssClassName此类型元素中输入元素的 USS 类名。
labelUssClassName此类型元素中标签的 USS 类名。
multilineInputUssClassName此类型元素中多行输入元素的 USS 类名。
placeholderUssClassName显示占位符文本时输入元素的 USS 类名
singleLineInputUssClassName此类型元素中单行输入元素的 USS 类名。
textInputUssName此类型元素中输入元素的 USS 类名。
ussClassName此类型元素的 USS 类名。
disabledUssClassName本地禁用元素的 USS 类名。

属性

label表示将出现在字段旁边的标签的字符串。
labelElement这是出现在字段输入旁边的标签对象。
mixedValueLabel用于提供编辑多个不同值的显示的只读标签。
rawValue元素的值。
showMixedValue设置为 true 时,会使字段呈现出编辑多个不同值的显示。
value与字段关联的值。
binding将要更新的绑定对象。
bindingPath要绑定的目标属性的路径。
canGrabFocus如果元素可以获得焦点,则返回 true。
delegatesFocus元素是否应该将焦点委派给其子元素。
focusable如果元素可以获得焦点,则为 true。
focusController返回此元素的焦点控制器。
tabIndex用于在焦点环中对可获得焦点的元素进行排序的整数。必须大于或等于零。
autoCorrection确定触摸屏键盘自动更正是否开启或关闭。
cursorColor光标的颜色。
cursorIndex这是显示文本中的光标索引。
cursorPosition文本光标在元素内的位置。
doubleClickSelectsWord控制双击是否选择鼠标指针下的单词。
emojiFallbackSupport指定系统在渲染文本时查找 Emoji 字符的顺序。如果启用此设置,则会首先在全局 Emoji 回退列表中搜索在 Unicode 14.0 标准中定义为 Emoji 的字符。
hideMobileInput隐藏或显示移动输入字段。
isDelayed如果设置为 true,则 value 属性不会更新,直到用户按下 Enter 键或文本字段失去焦点。
isPasswordField如果字段用于编辑密码,则返回 true。
isReadOnly如果字段为只读,则返回 true。
keyboardType将使用的移动键盘类型。
maskChar用于在密码字段中屏蔽的字符。
maxLength字段的最大字符数。
onIsReadOnlyChanged当 isReadOnly 发生更改时,调用其调用列表中的方法。
selectAllOnFocus控制元素在获得焦点时是否选择其内容。
selectAllOnMouseUp控制您第一次鼠标抬起时元素的内容是否被选中。
selectIndex这是显示文本中的选择索引。
selectionColor选中文本的背景颜色。
text输入字段的值。
textEdition检索此 Field 的 TextElement ITextEdition
textSelection检索此 Field 的 TextElement ITextSelection
touchScreenKeyboard正在显示的活动触摸键盘。
tripleClickSelectsLine控制三击是否选择鼠标指针下的整行。
verticalScrollerVisibility用于控制 TextInputBaseField_1 中垂直滚动条可见性的选项。
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指示元素文本的方向。该值将传播到元素的子元素。
layoutVisualElement 相对于其父元素的位置和大小,由布局系统计算得出。(只读)
localBound返回一个 Rect,表示应用变换后但应用布局平移前 Axis-aligned Bounding Box (AABB)。
name此 VisualElement 的名称。
paddingRect元素填充区域的矩形,位于元素的本地空间中。
panel此 VisualElement 附加到的面板。
parent此 VisualElement 的父元素。
pickingMode确定此元素是否可以在 mouseEvents 或 IPanel.Pick 查询期间被选中。
resolvedStyle视觉元素的最终渲染样式值,如它在当前帧中呈现的样式。(只读)
scaledPixelsPerPoint返回来自面板的最终缩放比例,该比例考虑屏幕 DPI 和可自定义的缩放比例,但不考虑元素及其祖先的变换比例。请参阅 Panel.scaledPixelsPerPoint。这应该只在属于面板的元素上调用。
schedule检索此 VisualElement 的 IVisualElementScheduler
style设置 VisualElement 上的样式值。
styleSheets返回一个 VisualElementStyleSheetSet,它可以操作附加到此元素的样式表。
this[int]检索特定索引处的子元素。
tooltip在用户将鼠标悬停在元素上一段时间后显示在信息框中的文本。这仅在编辑器 UI 中受支持。
transform返回此 VisualElement 的变换对象。ITransform
usageHints一组提示值,指定 VisualElement 的高级预期使用模式。此属性只能在 VisualElement 尚未成为 Panel 的一部分时设置。一旦成为 Panel 的一部分,此属性实际上就成为只读的,尝试更改它会导致抛出异常。正确 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尝试将焦点赋予此元素。
MeasureTextSize根据元素样式值(例如字体、字体大小和自动换行)计算显示文本字符串所需的尺寸。
SelectAll选择字段中包含的所有文本。
SelectNone取消选择
SelectRange选择光标索引和选择索引之间的文本。
Add向此元素的 contentContainer 添加一个元素。
AddToClassList向元素的类列表中添加一个类,以便从 USS 中分配样式。请注意,类名区分大小写。
BringToFront将此元素移至其父级子元素列表的末尾。该元素将在视觉上位于任何重叠的兄弟元素前面。
Children返回其 contentContainer 中的元素。
ClassListContains在该元素的类列表中搜索类。
Clear从该元素的 contentContainer 中删除所有子元素。
ClearBinding从元素中删除绑定。
ClearBindings从元素中删除所有绑定。
ClearClassList从该元素的类列表中删除所有类。AddToClassList
Contains检查该元素是否是指定子元素的祖先。
ContainsPoint检查指定点是否与该 VisualElement 的布局相交。
ElementAt检索特定索引处的子元素。
EnableInClassList启用或禁用具有给定名称的类。
FindAncestorUserData在该 VisualElement 的层次结构中向上搜索,并检索存储的 userData,如果找到的话。
FindCommonAncestor在 VisualTree 层次结构中查找两个 VisualElements 之间的最低公共祖先。
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。

受保护的方法

UpdateMixedValueContent根据 showMixedValue 更新字段的视觉内容。
HandleEventBubbleUp在该元素的 BubbleUp 回调之前,立即在该元素的 BubbleUp 阶段执行逻辑。调用 StopPropagation 将阻止沿传播路径进一步调用此方法。
HandleEventTrickleDown在该元素的 TrickleDown 回调之后,立即在该元素的 TrickleDown 阶段执行逻辑。调用 StopPropagation 将阻止沿传播路径进一步调用此方法。
NotifyPropertyChanged通知数据绑定系统控件的属性已更改。
StringToValue将字符串转换为子类中指定泛型类型的值。
ValueToString将子类中指定泛型类型的值转换为字符串表示形式。