Unity - 脚本 API: ToolbarToggle

描述

工具栏上的切换按钮。有关更多信息，请参阅 UXML 元素 ToolbarToggle。

静态属性

ussClassName

此类型元素的 USS 类名。

构造函数

ToolbarToggle

构造函数。

继承的成员

静态属性

alignedFieldUssClassName	在检查器元素中对齐的元素的 USS 类名
labelDraggerVariantUssClassName	此类型元素中标签的 USS 类名，当它们附加有拖动器时。
mixedValueLabelUssClassName	显示混合值的元素的 USS 类名
noLabelVariantUssClassName	此类型元素的 USS 类名，当没有标签时。
checkmarkUssClassName	切换元素中图像的 USS 类名。
inputUssClassName	切换元素中输入元素的 USS 类名。
labelUssClassName	切换元素中标签的 USS 类名。
mixedValuesUssClassName	具有混合值的切换元素的 USS 类名
noTextVariantUssClassName	没有文本的切换元素的 USS 类名。
textUssClassName	切换元素中文本元素的 USS 类名。
ussClassName	切换元素的 USS 类名。
disabledUssClassName	本地禁用元素的 USS 类名。

属性

text	在 BaseBoolField 之后出现的可选文本。
toggleOnLabelClick	用户点击标签时是否激活切换按钮。
label	表示字段旁边将显示的标签的字符串。
labelElement	这是出现在字段输入旁边的标签对象。
mixedValueLabel	用于提供编辑多个不同值的显示效果的只读标签。
rawValue	元素的值。
showMixedValue	设置为 true 时，将使字段具有编辑多个不同值的显示效果。
value	与字段关联的值。
binding	将要更新的绑定对象。
bindingPath	要绑定的目标属性的路径。
canGrabFocus	如果元素可以获得焦点，则返回 true。
delegatesFocus	元素是否应将焦点委托给其子元素。
focusable	如果元素可以获得焦点，则为 true。
focusController	返回此元素的焦点控制器。
tabIndex	用于在焦点环中对可获得焦点的元素进行排序的整数。必须大于或等于零。
childCount	此对象 contentContainer 中子元素的数量。
contentContainer	子元素将添加到其中，通常与元素本身相同。
contentRect	元素的内容区域的矩形，位于元素的本地空间中。（只读）
customStyle	VisualElement 的自定义样式属性访问器。（只读）
dataSource	将数据源分配给此 VisualElement，它将覆盖任何继承的数据源。此数据源由所有子元素继承。
dataSourcePath	从数据源到值的路径。
dataSourceType	可以分配给此 VisualElement 的数据源的可能类型。此信息仅由 UI 生成器使用，作为在设计时无法指定有效数据源时提供数据源路径字段的某些补全的提示。
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 尚未成为面板的一部分时设置。一旦成为面板的一部分，此属性就变成只读的，尝试更改它将抛出异常。指定适当的使用提示会促使系统更好地决定如何处理或加速某些操作，具体取决于预期的使用模式。请注意，这些提示不会影响行为或视觉结果，只会影响面板及其内部元素的整体性能。建议始终考虑指定适当的使用提示，但请记住，某些使用提示在某些情况下可能在内部被忽略（例如，由于目标平台上的硬件限制）。
userData	此属性可用于将应用程序特定的用户数据与此 VisualElement 关联。
viewDataKey	用于视图数据持久化，例如树展开状态、滚动位置或缩放级别。
visible	指示此元素是否应渲染。
visualTreeAssetSource	存储资产引用，如果生成的元素是从 VisualTreeAsset 克隆的。
worldBound	返回一个 Rect，表示应用世界变换后的轴对齐边界框 (AABB)。
worldTransform	返回一个矩阵，它累积了以下操作（按顺序）：-本地缩放-本地旋转-本地平移-布局平移-父级 worldTransform（递归定义-如果不存在父级，则考虑为单位矩阵）

公共方法

SetValueWithoutNotify	设置 BaseBoolField 的值，但不向层次结构的其余部分通知更改。
SetValueWithoutNotify	允许设置值，而不会在发生任何更改时收到通知。
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 渲染网格并且网格数据现在已更改时。
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。

Protected Methods

InitLabel	每当 BaseBoolField.text 属性更改时，初始化 Label 元素。
ToggleValue	反转 BaseBoolField.value 属性。
UpdateMixedValueContent	根据 showMixedValue 更新字段的视觉内容。
HandleEventBubbleUp	在 BubbleUp 阶段执行此元素上的逻辑，紧接在此元素的 BubbleUp 回调之前。调用 StopPropagation 将阻止沿着传播路径进一步调用此方法。
HandleEventTrickleDown	在 TrickleDown 阶段执行此元素上的逻辑，紧接在此元素的 TrickleDown 回调之后。调用 StopPropagation 将阻止沿着传播路径进一步调用此方法。
NotifyPropertyChanged	通知数据绑定系统控件的属性已更改。

脚本 API

ToolbarToggle

成功！

提交失败

描述

静态属性

构造函数

继承的成员

静态属性

属性

公共方法

Protected Methods