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

ScrollView

UnityEngine.UIElements 中的类

/

继承自:UIElements.VisualElement

/

实现于:UnityEngine.UIElementsModule

建议更改

成功!

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

关闭

提交失败

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

关闭

取消

描述

在可滚动的框架内显示其内容。有关更多信息,请参阅 ScrollView

静态属性

contentAndVerticalScrollUssClassName此类型元素中内容元素的 USS 类名。
contentUssClassName此类型元素中内容元素的 USS 类名。
horizontalVariantContentUssClassName当 ContentContainer 处于水平模式时添加的 USS 类名。ScrollViewMode.Horizontal
horizontalVariantUssClassName当 ScrollView 处于水平模式时添加的 USS 类名。ScrollViewMode.Horizontal
horizontalVariantViewportUssClassName当 Viewport 处于水平模式时添加的 USS 类名。ScrollViewMode.Horizontal
hScrollerUssClassName此类型元素中水平滚动条的 USS 类名。
ussClassName此类型元素的 USS 类名。
verticalHorizontalVariantContentUssClassName当 ContentContainer 同时处于水平和垂直模式时添加的 USS 类名。ScrollViewMode.VerticalAndHorizontal
verticalHorizontalVariantUssClassName当 ScrollView 同时处于水平和垂直模式时添加的 USS 类名。ScrollViewMode.VerticalAndHorizontal
verticalHorizontalVariantViewportUssClassName当 Viewport 同时处于水平和垂直模式时添加的 USS 类名。ScrollViewMode.VerticalAndHorizontal
verticalVariantContentUssClassName当 ContentContainer 处于垂直模式时添加的 USS 类名。ScrollViewMode.Vertical
verticalVariantUssClassName当 ScrollView 处于垂直模式时添加的 USS 类名。ScrollViewMode.Vertical
verticalVariantViewportUssClassName当 Viewport 处于垂直模式时添加的 USS 类名。ScrollViewMode.Vertical
viewportUssClassName此类型元素中视口元素的 USS 类名。
vScrollerUssClassName此类型元素中垂直滚动条的 USS 类名。

属性

contentContainer包含完整内容,可能部分可见。
contentViewport表示 contentContainer 的可见部分。
elasticAnimationIntervalMs弹性弹簧动画执行之间最短时间(以毫秒为单位)。
elasticity用户尝试滚动到滚动视图边界之外时使用的弹性量。
horizontalPageSize此属性根据页面大小控制使用键盘或屏幕上的滚动条按钮(箭头和手柄)时水平滚动的速度。
horizontalScroller水平滚动条。
horizontalScrollerVisibility指定水平滚动条是否可见。
mode控制 ScrollView 如何允许用户滚动内容。ScrollViewMode
mouseWheelScrollSize此属性仅在使用鼠标滚轮时控制滚动速度,根据页面大小。它优先于 --unity-metrics-single_line-height USS 变量。
nestedInteractionKind滚动到达嵌套 ScrollView 的限制时使用的行为。
scrollDecelerationRate控制用户使用触摸交互滚动后滚动运动减慢的速度。
scrollOffset当前滚动位置。
touchScrollBehavior用户尝试使用触摸交互滚动到 ScrollView 内容边界之外时使用的行为。
verticalPageSize此属性根据页面大小控制使用键盘或屏幕上的滚动条按钮(箭头和手柄)时垂直滚动的速度。
verticalScroller垂直滚动条。
verticalScrollerVisibility指定垂直滚动条是否可见。

构造函数

ScrollView构造函数。

公共方法

ScrollTo滚动到特定子元素。

继承的成员

静态属性

disabledUssClassName本地禁用元素的 USS 类名。

属性

canGrabFocus如果元素可以聚焦,则返回 true。
delegatesFocus元素是否应将其焦点委托给其子元素。
focusable如果元素可以聚焦,则为 true。
focusController返回此元素的焦点控制器。
tabIndex用于在焦点环中对可聚焦对象进行排序的整数。必须大于或等于零。
childCount此对象 contentContainer 中子元素的数量。
contentContainer子元素添加到其中,通常与元素本身相同。
contentRect元素内容区域的矩形,位于元素的本地空间中。(只读)
customStyleVisualElement 的自定义样式属性访问器(只读)。
dataSource为此 VisualElement 分配数据源,该数据源会覆盖任何继承的数据源。此数据源由所有子元素继承。
dataSourcePath从数据源到值的路径。
dataSourceType可以分配给此 VisualElement 的数据源的可能类型。此信息仅由 UI 生成器用作提示,以便在设计时无法指定有效数据源时为数据源路径字段提供一些完成。
disablePlayModeTint除非将其设置为 true,否则默认情况下会应用播放模式色调。它会分层应用于此 VisualElement 及其在编辑器面板上存在的所有子元素。
enabledInHierarchy如果 VisualElement 在其自己的层次结构中启用,则返回 true。
enabledSelf如果 VisualElement 在本地启用,则返回 true。
experimental返回 UIElements 实验性接口。
generateVisualContent委托函数,用于生成视觉元素的视觉内容。
hierarchy访问此元素的物理层次结构
languageDirection指示元素文本的方向性。该值将传播到元素的子元素。
layoutVisualElement 相对于其父元素的位置和大小,由布局系统计算。(只读)
localBound返回一个表示轴对齐边界框 (AABB) 的 Rect,在应用变换后但应用布局平移之前。
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返回一个表示应用世界变换后的轴对齐边界框 (AABB) 的 Rect。
worldTransform返回一个矩阵,该矩阵累积以下操作(按顺序):-本地缩放-本地旋转-本地平移-布局平移-父 worldTransform(递归定义-在没有父元素时考虑恒等式)

公共方法

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。

受保护方法

HandleEventBubbleUp在冒泡阶段在此元素上执行逻辑,紧接在此元素的冒泡回调之前。调用 StopPropagation 将阻止在此传播路径上进一步调用此方法。
HandleEventTrickleDown在向下传递阶段在此元素上执行逻辑,紧接在此元素的向下传递回调之后。调用 StopPropagation 将阻止在此传播路径上进一步调用此方法。
NotifyPropertyChanged通知数据绑定系统控件的属性已更改。