Unity - 脚本 API: ToolbarSearchField

描述

工具栏的搜索字段。有关更多信息，请参阅UXML 元素 ToolbarSearchField.

静态属性

cancelButtonOffVariantUssClassName	此类型元素中取消按钮的 USS 类名，当它们处于关闭状态时。
cancelButtonUssClassName	此类型元素中取消按钮的 USS 类名。
popupVariantUssClassName	此类型元素的 USS 类名，当它们使用弹出菜单时。
searchButtonUssClassName	此类型元素中搜索按钮的 USS 类名。
textUssClassName	此类型元素中文本元素的 USS 类名。
ussClassName	此类型元素的 USS 类名。

属性

searchButton

搜索按钮。

构造函数

ToolbarSearchField

构造函数。

受保护的方法

ClearTextField	清除字段时删除文本。
FieldIsEmpty	判断字符串是否为 null 或空。

继承的成员

静态属性

cancelButtonOffVariantUssClassName	此类型元素中取消按钮的 USS 类名，当它们处于关闭状态时。
cancelButtonUssClassName	此类型元素中取消按钮的 USS 类名。
popupVariantUssClassName	此类型元素的 USS 类名，当它们使用弹出菜单时。
searchButtonUssClassName	此类型元素中搜索按钮的 USS 类名。
textInputUssClassName	此类型元素中文本输入元素的 USS 类名。
textUssClassName	此类型元素中文本元素的 USS 类名。
ussClassName	此类型元素的 USS 类名。
disabledUssClassName	本地禁用元素的 USS 类名。

属性

canGrabFocus	如果元素可以获得焦点，则返回 true。
delegatesFocus	元素是否应将其焦点委托给其子元素。
focusable	如果元素可以获得焦点，则为 true。
focusController	返回此元素的焦点控制器。
tabIndex	用于在焦点环中对可获得焦点的元素进行排序的整数。必须大于或等于零。
placeholderText	一个简短的提示，帮助用户了解在字段中输入什么。
searchButton	搜索按钮。
value	字段当前公开的对象。
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	确定此元素是否可以在鼠标事件或 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	返回一个矩阵，它累积以下操作（按顺序）：-本地缩放 -本地旋转 -本地平移 -布局平移 -父世界变换（递归定义 - 如果没有父元素，则考虑单位矩阵）

公共方法

HasBubbleUpHandlers	如果事件传播 BubbleUp 阶段的事件处理程序已附加到此对象，则返回 true。
HasTrickleDownHandlers	如果事件传播 TrickleDown 阶段的事件处理程序已附加到此对象，则返回 true。
RegisterCallback	向实例添加事件处理程序。如果事件处理程序已为同一阶段（TrickleDown 或 BubbleUp）注册，则此方法无效。
RegisterCallbackOnce	向实例添加事件处理程序。如果事件处理程序已为同一阶段（TrickleDown 或 BubbleUp）注册，则此方法无效。事件处理程序在完全调用一次后会自动取消注册。
UnregisterCallback	从实例中删除回调。
Blur	告诉元素释放焦点。
Focus	尝试将焦点赋予此元素。
SetValueWithoutNotify	设置工具栏搜索字段的值，而不发送更改事件。
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。

受保护的方法

HandleEventBubbleUp	在 BubbleUp 阶段执行此元素上的逻辑，紧接在该元素的 BubbleUp 回调之前。调用 StopPropagation 将阻止沿着传播路径进一步调用此方法。
HandleEventTrickleDown	在 TrickleDown 阶段执行此元素上的逻辑，紧接在该元素的 TrickleDown 回调之后。调用 StopPropagation 将阻止沿着传播路径进一步调用此方法。
NotifyPropertyChanged	通知数据绑定系统控件的某个属性已更改。
FieldIsEmpty	指示该字段是否为空。其含义取决于 T 的类型。

脚本 API

ToolbarSearchField

成功！

提交失败

描述

静态属性

属性

构造函数

受保护的方法

继承的成员

静态属性

属性

公共方法

受保护的方法