Scroller

Scroller 允许用户滚动用户界面中的内容。

创建 Scroller

您可以使用__ UI__（即用户界面，User Interface）让用户能够与您的应用程序进行交互。Unity 目前支持三种 UI 系统。更多信息
See in Glossary Builder、UXML 或 C# 创建 Scroller以下 C# 示例将创建具有默认值、下限值和上限值的 Scroller，并设置 Scroller 的方向：

var scroller = new Scroller();
scroller.value = 42;
scroller.lowValue = 0;
scroller.highValue = 100;
scroller.direction = SliderDirection.Vertical;

示例

以下 UXML 示例将创建 Scroller：

<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements">
    <Scroller
        name="the-uxml-scroller"
        direction="Horizontal"
        low-value="0"
        high-value="100" />
</UXML>

以下 C# 示例说明了 Scroller 的一些可自定义功能：

/// <sample>
// Get a reference to the scroller from UXML and assign it its value.
var uxmlField = container.Q<Scroller>("the-uxml-scroller");
uxmlField.valueChanged += (v) => {};
uxmlField.value = 42;

// Create a new scroller, disable it, and give it a style class.
var csharpField = new Scroller(0, 100, (v) => {}, SliderDirection.Vertical);
csharpField.SetEnabled(false);
csharpField.AddToClassList("some-styled-scroller");
csharpField.value = uxmlField.value;
container.Add(csharpField);

// Mirror value of uxml scroller into the C# field.
uxmlField.RegisterCallback<ChangeEvent<float>>((evt) =>
{
    csharpField.value = evt.newValue;
});
/// </sample>

要在 Unity 中实时试用此示例，请转到窗口 (Window) > UI 工具包 (UI Toolkit) > 示例 (Samples)。

C# 基类和命名空间

C# 类：Scroller
命名空间：UnityEngine.UIElements
基类：VisualElement

成员 UXML 属性

此元素具有以下成员属性：

名称	类型	描述
`direction`	`UIElements.SliderDirection`	此滚动条的方向。
`high-value`	`float`	最大值。
`low-value`	`float`	最小值。
`value`	`float`	定义滑动条位置的值。它位于 `lowValue` 和 `highValue` 之间。

继承 UXML 属性

此元素从其基类继承以下属性：

名称	类型	描述
`focusable`	`boolean`	如果元素可以聚焦，则为 true。
`tabindex`	`int`	用于对焦点环中可获得焦点的元素排序的整数。必须大于或等于零。

此元素还从 VisualElement 继承以下属性：

名称	类型	描述
`content-container`	`string`	向其添加子元素，通常与元素本身相同。
`data-source`	`Object`	为此 VisualElement 分配一个数据源，此数据源将覆盖任何已继承的数据源。此数据源由所有子项继承。
`data-source-path`	`string`	从数据源到值的路径。
`data-source-type`	`System.Type`	可分配给此 VisualElement 的可能数据源的类型。仅当在设计时无法指定有效数据源时，UI Builder 才使用此信息作为补全数据源路径字段的提示。
`language-direction`	`UIElements.LanguageDirection`	指示元素文本的方向性。该值将传播到元素的子项。将 languageDirection 设置为 RTL，即可通过反转文本、处理换行和单词自动换行的方式，提供对从右到左 (RTL) 语言的基本支持。但是，它不提供全面的 RTL 支持，因为这需要文本整形（包括字符重新排序）和 OpenType 字体功能支持。未来更新计划提供全面的 RTL 支持，这将涉及额外的 API 来处理语言、脚本和字体功能规范。要增强此属性的 RTL 功能，用户可以在 Unity 资源商店中探索可用的第三方插件，并使用 `ITextElementExperimentalFeatures.renderedText`
`name`	`string`	此 VisualElement 的名称。使用此属性可编写针对特定元素的 USS 选择器。标准做法是为元素指定唯一名称。
`picking-mode`	`UIElements.PickingMode`	确定是否可以在 mouseEvents 或 `IPanel.Pick` 查询期间选择此元素。
`style`	`string`	设置 `VisualElement` 样式值。
`tooltip`	`string`	用户将光标悬停在元素上一小段时间后信息框内显示的文本。仅在编辑器 UI 中受支持。
`usage-hints`	`UIElements.UsageHints`	用于指定 `VisualElement` 高级预期使用模式的提示值组合。仅当 `VisualElement` 尚未成为 `Panel` 的一部分时，才能设置此属性。一旦成为 `Panel` 的一部分，此属性实际上就变为只读，尝试更改此属性将显示异常。适当的 `UsageHints` 规范会促使系统根据预期的使用模式，做出更好的决策，以处理或加速某些操作。请注意，这些提示不会影响行为或视觉效果，只会影响面板及其元素的整体性能。建议始终考虑指定适当的 `UsageHints`，但请记住，在某些情况下（例如，由于目标平台上的硬件限制），某些 `UsageHints` 可能会在内部被忽略。
`view-data-key`	`string`	用于 View Data 持久性，例如树展开状态、滚动位置或缩放级别。此键用于保存和加载 View Data 存储中的视图数据。如果未设置此键，则会对关联的 `VisualElement` 禁用持久性。有关更多信息，请参阅 View Data 持久性。

USS 类

下表列出了所有 C# 公共属性名称及其相关的 USS 选择器。

C# 属性	USS 选择器	描述
`ussClassName`	`.unity-scroller`	此类型元素的 USS 类名称。
`horizontalVariantUssClassName`	`.unity-scroller--horizontal`	水平显示时，此类型元素的 USS 类名称。
`verticalVariantUssClassName`	`.unity-scroller--vertical`	垂直显示时，此类型元素的 USS 类名称。
`sliderUssClassName`	`.unity-scroller__slider`	此类型元素中滑动条元素的 USS 类名称。
`lowButtonUssClassName`	`.unity-scroller__low-button`	此类型元素中低设置按钮的 USS 类名称。
`highButtonUssClassName`	`.unity-scroller__high-button`	此类型元素中高设置按钮的 USS 类名称。
`disabledUssClassName`	`.unity-disabled`	本地被禁用元素的 USS 类名称。

还可以使用检视器中的匹配选择器 (Matching Selectors) 部分或 UI 工具包调试器来查看哪些 USS 选择器在其层级视图的每个级别上影响 VisualElement 的组件。

其他资源

滚动视图 (ScrollView)

滚动视图 (ScrollView)

Slider

Unity 手册

Scroller

创建 Scroller

示例

C# 基类和命名空间

成员 UXML 属性

继承 UXML 属性

USS 类

其他资源