ScrollBar — C# API

Базовая полоса прокрутки с числовым состоянием Range.

class ScrollBarReckfellSharpНаследует Range

Используйте HScrollBar или VScrollBar; для автоматической прокрутки содержимого обычно нужен ScrollContainer. Отдельная полоса хранит число, но не перемещает произвольный Control без вашей связи с ValueChanged.

MinValue/MaxValue задают полный диапазон, Page — видимый размер страницы. Обычный предел Value равен MaxValue − Page: при диапазоне 0…100 и Page = 20 последнее значение равно 80. Page не является шагом колеса. В отличие от базового Range, конструктор ScrollBar задаёт Step = 0.

CustomStep по умолчанию -1: отрицательное значение использует Step для стрелок и соответствующих клавиш; неотрицательное задаёт их приращение. Это не сетка округления Value и не общий шаг всех способов прокрутки. Если Step = 0 и CustomStep отрицателен, такие приращения могут быть нулевыми. Колесо использует долю Page / 8, а при нулевой Page — диапазон / 16, затем учитывает Step и ограничения Range.

ValueChanged удобен для обычных изменений значения, включая программные. Scrolling относится к отдельным путям прокрутки и не испускается при обычном присваивании Value. SetValueNoSignal не испускает ни один из этих сигналов. Не используйте Scrolling как универсальное уведомление о каждом изменении числа.

Range.

Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.

Свойства1

CustomStepСвойство

# CustomStep

C#
public float CustomStep { get; set; }

Приращение стрелок и соответствующих клавиш; -1 по умолчанию использует Step. Неотрицательное значение задаёт собственное приращение, 0 может не менять число. Не управляет шагом колеса и не округляет программные Value.

Методы2

GetCustomStepfloat

# GetCustomStep

C#
public float GetCustomStep();

Возвращает float

Сохранённое приращение float; отрицательное значение означает использование Step.

SetCustomStepvoid

# SetCustomStep

C#
public void SetCustomStep(float step);

Параметры
Имя	Тип	По умолчанию
`step`	`float`	—

step

Сигналы и события1

ScrollingСобытие

# Scrolling

public event Action Scrolling;

Сигнал отдельных путей пользовательской прокрутки, не универсальное изменение Range. Обычное присваивание Value и SetValueNoSignal его не испускают. Для обычной числовой реакции используйте ValueChanged.

Свойства темы

Это ключи ресурсов Theme, а не свойства C# класса. Используйте методы GetTheme…() и AddTheme…Override() у Control с соответствующим типом значения.

Ключ и тип	Описание
`icon_max_size` `int`	Максимальный допустимый размер `ScrollBar`Приращение и опускание значков. Текстура уменьшена, так что ее самая широкая ось - [citle_item igblic_max_max], а другая ось масштабируется при сохранении первоначального соотношения. По умолчанию: `0`
`decrement` `Texture2D`	Значок используется как кнопка для прокрутки `ScrollBar` влево/вверх. Поддерживает пользовательский шаг с использованием свойства `ScrollBar.CustomStep`.
`decrement_highlight` `Texture2D`	Отображается при наведении курсора мыши на кнопку уменьшения.
`decrement_pressed` `Texture2D`	Отображается при нажатии кнопки уменьшения.
`increment` `Texture2D`	Значок используется как кнопка для прокрутки `ScrollBar` вправо/вниз. Поддерживает пользовательский шаг с использованием свойства `ScrollBar.CustomStep`.
`increment_highlight` `Texture2D`	Отображается при наведении курсора мыши на кнопку увеличения.
`increment_pressed` `Texture2D`	Отображается при нажатии кнопки увеличения.
`drag_ended_sound` `AudioStream`	Играли, когда мышь или прикосновение заканчивались.
`drag_started_sound` `AudioStream`	Играет, когда мышь или прикосновение начинаются.
`value_change_rejected_sound` `AudioStream`	Проигрывается, когда значение пытается изменить с помощью клавиатуры или геймпада, но это значение уже является минимальным (или максимальным).
`value_changed_sound` `AudioStream`	Воспроизводится, когда значение изменяется через клавиатуру или вход в игровую папку. Если значение уже находится на минимальном (или максимальном) уровне, [Вместо этого используется тема_позиция_изменение_отклонение_звук].
`grabber` `StyleBox`	Используется в качестве текстуры для граббера, перетаскиваемого элемента, представляющего текущую прокрутку.
`grabber_highlight` `StyleBox`	Используется, когда указатель мыши наведен на захват.
`grabber_pressed` `StyleBox`	Используется при перетаскивании захвата.
`scroll` `StyleBox`	Используется как фон для `ScrollBar`.
`scroll_focus` `StyleBox`	Используется в качестве фона, когда `ScrollBar` имеет фокус GUI .