Unity - 脚本 API: TextField

描述

TextField 接受并显示文本输入。有关更多信息，请参阅UXML 元素 TextField。

静态属性

inputUssClassName	此类型元素中输入元素的 USS 类名。
labelUssClassName	此类型元素中标签的 USS 类名。
ussClassName	此类型元素的 USS 类名。

属性

multiline	将此设置为 true 以允许文本字段中的多行，否则设置为 false。
value	字段当前公开的字符串。

构造函数

TextField

创建一个新的文本字段。

继承的成员

静态属性

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	元素内容区域的矩形，在元素的本地空间中。（只读）
customStyle	VisualElement 的自定义样式属性访问器。（只读）
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，表示在应用变换后但应用布局平移之前，轴对齐的边界框 (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，表示应用世界变换后的轴对齐的边界框 (AABB)。
worldTransform	返回一个矩阵，它累加以下操作（按顺序）：- 局部缩放 - 局部旋转 - 局部平移 - 布局平移 - 父级 worldTransform（递归定义 - 当没有父级时，考虑恒等矩阵）

公共方法

SetValueWithoutNotify	允许设置值而不会收到更改通知（如果有）。
HasBubbleUpHandlers	如果事件传播 BubbleUp 阶段的事件处理程序已附加到此对象，则返回 true。
HasTrickleDownHandlers	如果事件传播 TrickleDown 阶段的事件处理程序已附加到此对象，则返回 true。
RegisterCallback	向实例添加事件处理程序。如果事件处理程序已为同一阶段（TrickleDown 或 BubbleUp）注册，则此方法无效。
RegisterCallbackOnce	向实例添加事件处理程序。如果事件处理程序已为同一阶段（TrickleDown 或 BubbleUp）注册，则此方法无效。事件处理程序在被精确调用一次后会自动取消注册。
UnregisterCallback	从实例中删除回调。
Blur	告诉元素释放焦点。
Focus	尝试将焦点赋予此元素。
MeasureTextSize	根据元素样式值（例如字体、字体大小和自动换行）计算显示文本字符串所需的尺寸。
SelectAll	选择字段中包含的所有文本。
SelectNone	移除选择
SelectRange	选择 cursorIndex 和 selectIndex 之间的文本。
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。

受保护方法

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

脚本 API

TextField

成功！

提交失败

描述

静态属性

属性

构造函数

继承的成员

静态属性

属性

公共方法

受保护方法