UXML 元素 Scroller

Scroller 允许用户在您的用户界面中滚动浏览内容。

创建 Scroller

您可以使用 UI(用户界面) 允许用户与您的应用程序进行交互。Unity 目前支持三种 UI 系统。更多信息
参见词汇表生成器、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 中实时运行此示例，请转至窗口 > UI 工具包 > 示例。

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 生成器用作提示，以便在设计时无法指定有效数据源时，为数据源路径字段提供一些自动完成。
`language-direction`	`UIElements.LanguageDirection`	指示元素文本的方向。该值将传播到元素的子元素。将 languageDirection 设置为 RTL 通过反转文本并适当地处理换行和自动换行，为从右到左 (RTL) 添加基本支持。但是，它不提供全面的 RTL 支持，因为这将需要文本整形，包括字符的重新排序，以及 OpenType 字体功能支持。全面的 RTL 支持计划在未来的更新中提供，这将涉及处理语言、脚本和字体功能规范的更多 API。为了增强此属性的 RTL 功能，用户可以探索 Unity Asset Store 中可用的第三方插件，并使用 `ITextElementExperimentalFeatures.renderedText`
`name`	`string`	此 VisualElement 的名称。使用此属性编写针对特定元素的 USS 选择器。标准做法是为元素提供唯一名称。
`picking-mode`	`UIElements.PickingMode`	确定在鼠标事件或 `IPanel.Pick` 查询期间是否可以拾取此元素。
`style`	`string`	设置 `VisualElement` 样式值。
`tooltip`	`string`	在用户将鼠标悬停在元素上一段时间后，将在信息框中显示的文本。这仅在编辑器 UI 中受支持。
`usage-hints`	`UIElements.UsageHints`	指定 `VisualElement` 的高级预期使用模式的提示值的组合。此属性只能在 `VisualElement` 尚未成为 `Panel` 的一部分时设置。一旦成为 `Panel` 的一部分，此属性实际上就变为只读，尝试更改它将引发异常。指定适当的 `UsageHints` 会促使系统在处理或加速某些操作时做出更好的决定，这些决定基于预期的使用模式。请注意，这些提示不会影响行为或视觉结果，而只会影响面板和面板内元素的整体性能。建议始终考虑指定适当的 `UsageHints`，但请记住，在某些情况下某些 `UsageHints` 可能会被内部忽略（例如，由于目标平台上的硬件限制）。
`view-data-key`	`string`	用于视图数据持久性，例如树展开状态、滚动位置或缩放级别。此键用于从视图数据存储中保存和加载视图数据。如果您没有设置此键，则关联的 `VisualElement` 的持久性将被禁用。有关更多信息，请参阅视图数据持久性。

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 类名。

您还可以使用检查器或 UI 工具包调试器中的匹配选择器部分查看哪些 USS 选择器影响 VisualElement 层次结构中每个级别的组件。

其他资源

ScrollView一个 UI 控件，它在一个可视区域中显示一组大型控件，您可以使用滚动条查看该区域。更多信息
参见词汇表

UXML 元素 ScrollView

UXML 元素 Slider

Unity 手册

UXML 元素 Scroller

创建 Scroller

示例

C# 基类和命名空间

成员 UXML 属性

继承的 UXML 属性

USS 类

其他资源