Experimental: this API is experimental and might be changed or removed in the future.

TextField

class in UnityEngine.Experimental.UIElements

/

继承自:Experimental.UIElements.VisualElement

切换到手册

描述

文本字段是用户可以在其中编辑字符串的矩形区域。

变量

cursorColor光标的颜色。
doubleClickSelectsWord要允许通过双击选择鼠标下的文字,则将此设置为 true,否则设置为 false。
hasFocus如果文本字段具有焦点,则返回 true,否则返回 false。
isPasswordField要遮罩字符,则将此设置为 true,否则设置为 false。
maskChar密码字段中用于遮罩的字符。
maxLength此文本字段可容纳的最大字符数。0 表示没有限制。
multiline要允许文本字段中有多行字符,则将此设置为 true,否则设置为 false。
OnTextChanged每当此文本字段中的文本发生更改时调用的操作。
OnTextChangeValidated当用户验证此文本字段中的文本时调用的操作。
selectionColor文本选择的颜色。
tripleClickSelectsLine要允许通过三击选择鼠标下的行,则将此设置为 true,否则设置为 false。

构造函数

TextField创建新文本字段。

公共函数

OnPersistentDataReady当持久数据可访问和/或当数据或持久键发生更改时调用(VisualElement 有正确的父子关系)。

继承的成员

变量

canGrabFocus如果元素可以获得焦点,则返回 true。
focusController返回此元素的焦点控制器。
focusIndex用于对焦点环中可获得焦点的元素排序的整数。负值表示元素不能获得焦点。
childCount 此对象的 contentContainer 中的子元素数
clippingOptions是否应将此元素裁剪为绘制到其边界。
contentContainer 子元素通常添加到此元素中
dataWatch对此元素 DataWatch 接口的访问。
enabledInHierarchy如果 VisualElement 是在它自己的层级视图中启用,则返回 true。
enabledSelf如果 VisualElement 是本地启用,则返回 true。
persistenceKey用于查看数据持久性(即树展开状态、滚动位置、缩放级别)。
schedule检索此 VisualElement 的 IVisualElementScheduler
shadow 访问此元素物理层级视图
style引用此元素的样式对象。
this[int] 访问此元素物理层级视图
userData此属性可用于将特定于应用程序的用户数据与此 VisualElement 关联。

公共函数

HandleEvent处理事件,通常是通过执行与事件关联的回调处理事件。
HasBubbleHandlers如果事件传播 BubbleUp 阶段的事件处理程序已附加到此对象,则返回 true。
HasCaptureHandlers如果事件传播捕 Capture 阶段的事件处理程序已附加到此对象,则返回 true。
OnLostCapture当元素丢失捕获时调用。未来版本中将删除。
RegisterCallback在实例上添加事件处理程序。如果已经在同一阶段(Capture 或 Bubbling)注册了处理程序,这不会有效果。
UnregisterCallback从此实例删除回调。
Blur通知元素释放焦点。
Focus尝试让此元素获得焦点。
Add向此元素的 contentContainer 添加一个元素
AddStyleSheetPath将此样式表文件添加到此元素的应用样式列表中
AnyDirty检查是否有任何 ChangeType 标记为已更新。
Children从元素的 contentContainer 返回元素
Clear从此元素的 contentContainer 中删除所有子元素
Contains如果元素是此 VisualElement 的直接子级,则返回 true
ElementAt检索相应位置的子元素
FindAncestorUserData向上搜索此 VisualElement 的层级视图并检索存储的 userData(如果找到)。
GetEnumerator允许循环访问此元素的子级
GetFirstAncestorOfType从此元素的父级开始向上访问层级视图,返回第一个此类型的 VisualElement
GetFirstOfType从此元素开始向上访问层级视图,返回第一个此类型的 VisualElement
GetFullHierarchicalPersistenceKey将此 VisualElement 与其父级的 VisualElement.persistenceKey 进行组合,从而创建更具唯一性的键以供 VisualElement.GetOrCreatePersistentData 使用。
GetOrCreatePersistentData引用现有的持久化对象和键,返回以保持的状态填充的对象或原样返回对象。
HasStyleSheetPath检查此样式表文件是否位于此元素的应用样式列表中
Insert向此元素的 contentContainer 插入一个元素
OnStyleResolved当对象样式发生更改时回调。
OverwriteFromPersistedData从持久性数据存储覆盖对象。
Remove从层级视图中删除此子级
RemoveAt从此元素的 contentContainer 中删除位于此位置的子元素
RemoveFromHierarchy将此元素从其父层级视图中删除
RemoveStyleSheetPath从此元素的应用样式列表中删除此样式表文件
SavePersistentData将持久性数据写入文件。
SetEnabled更改 VisualElement 启用状态。禁用的 VisualElement 不接收大多数事件。
Sort重新排序来自此 VisualElement contentContainer 的子元素。