ProgressBar — C# API

Индикатор известного прогресса или неопределённого ожидания.

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

Для известного объёма работы задайте MinValue, MaxValue и Value; например, 0, 200 и 50 означают 25%, а не 50%. Значение обновляет ваш код: ProgressBar не отслеживает загрузку самостоятельно. По умолчанию Step = 0.01, ShowPercentage = true, Indeterminate = false. Не блокируйте основной поток длительной задачей: иначе интерфейс не сможет обновляться.

FillMode задаёт направление заполнения. BeginToEnd/EndToBegin учитывают RTL; вертикальные режимы направлены сверху вниз или снизу вверх. Цвета и форму задают theme-ресурсы background/fill. Процент рассчитывается по всему MinValue…MaxValue; Page уменьшает достижимое Value, поэтому обычно оставляйте Page = 0.

Indeterminate = true показывает движущуюся область ожидания без процента и без вычисления Value. ShowPercentage при этом может оставаться true в данных, но текст не рисуется. Возврат в обычный режим сохраняет прежнее Value. EditorPreviewIndeterminate управляет анимацией только в редактируемом уровне, не в запущенной игре.

AllowGreater/AllowLesser могут разрешить процентную надпись за пределами 0…100%, хотя геометрия обычного заполнения использует ограниченный Ratio. Для обычного индикатора готовности оставьте эти разрешения выключенными.

Range.

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

Конструкторы1

ProgressBarКонструктор

# ProgressBar

C#
public ProgressBar();

Создаёт индикатор с Step = 0.01, ShowPercentage = true, Indeterminate = false и направлением BeginToEnd. Объём работы и Value задаёт ваш код.

Свойства4

EditorPreviewIndeterminateСвойство

# EditorPreviewIndeterminate

C#
public bool EditorPreviewIndeterminate { get; set; }

Разрешает анимацию Indeterminate в редактируемом уровне, false по умолчанию. Не управляет анимацией запущенной игры и не является настройкой скорости.

FillModeСвойство

# FillMode

C#
public int FillMode { get; set; }

Направление заполнения, BeginToEnd по умолчанию. Используйте значения ProgressBar.FillModeEnum, приведённые к int: BeginToEnd, EndToBegin, TopToBottom, BottomToTop. Горизонтальные режимы учитывают RTL.

IndeterminateСвойство

# Indeterminate

C#
public bool Indeterminate { get; set; }

Режим ожидания без известной доли, false по умолчанию. Включает внутреннюю анимацию при работающем интерфейсе, не вычисляет и не изменяет Value. В этом режиме процент не рисуется; после отключения прежнее Value сохраняется.

ShowPercentageСвойство

# ShowPercentage

C#
public bool ShowPercentage { get; set; }

Показывать процентную надпись, true по умолчанию. Доля считается по MinValue…MaxValue. При Indeterminate надпись не рисуется независимо от сохранённого true; это не меняет Value.

Методы8

GetFillModeint

# GetFillMode

C#
public int GetFillMode();

Возвращает int

Текущее значение настройки, не подтверждение ввода или визуальной проверки.

IsEditorPreviewIndeterminateEnabledbool

# IsEditorPreviewIndeterminateEnabled

C#
public bool IsEditorPreviewIndeterminateEnabled();

Возвращает bool

Текущее значение настройки, не подтверждение ввода или визуальной проверки.

IsIndeterminatebool

# IsIndeterminate

C#
public bool IsIndeterminate();

Возвращает bool

Текущее значение настройки, не подтверждение ввода или визуальной проверки.

IsPercentageShownbool

# IsPercentageShown

C#
public bool IsPercentageShown();

Возвращает bool

Текущее значение настройки, не подтверждение ввода или визуальной проверки.

SetEditorPreviewIndeterminatevoid

# SetEditorPreviewIndeterminate

C#
public void SetEditorPreviewIndeterminate(bool previewIndeterminate);

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

previewIndeterminate

SetFillModevoid

# SetFillMode

C#
public void SetFillMode(int mode);

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

mode

SetIndeterminatevoid

# SetIndeterminate

C#
public void SetIndeterminate(bool indeterminate);

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

indeterminate

SetShowPercentagevoid

# SetShowPercentage

C#
public void SetShowPercentage(bool visible);

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

visible

ProgressBar.FillModeEnum

Значение	Описание
`BeginToEnd = 0`	Полоса прогресса заполняется от начала до конца горизонтально, в соответствии с направлением языка. Если `Control.IsLayoutRtl` возвращает `false`, она заполняется слева направо, а если возвращает `true`, она заполняется справа налево.
`BottomToTop = 3`	Прогресс заполняется снизу вверх.
`EndToBegin = 1`	Полоса прогресса заполняется от конца к началу горизонтально, в соответствии с направлением языка. Если `Control.IsLayoutRtl` возвращает `false`, она заполняется справа налево, а если возвращает `true`, она заполняется слева направо.
`TopToBottom = 2`	Прогресс заполняется сверху вниз.

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

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

Ключ и тип	Описание
`font_color` `Color`	Цвет текста. По умолчанию: `Color(0.95, 0.95, 0.95, 1)`
`font_outline_color` `Color`	Оттенок контура текста `ProgressBar`. По умолчанию: `Color(0, 0, 0, 1)`
`outline_size` `int`	Размер контура текста. Примечание: При использовании шрифта с включенным `FontFile.MultichannelSignedDistanceField` его `FontFile.MsdfPixelRange` должен быть установлен как минимум в дважды значения `ProgressBar.outline_size`, чтобы контур выглядел правильно. В противном случае контур может оказаться обрезанным раньше, чем предполагалось. По умолчанию: `0`
`font` `Font`	Font используется для определения процентной доли заполнения, если `ProgressBar.ShowPercentage` это `true`.
`font_size` `int`	Font Размер, используемый для расчета процентной доли заполнения, если `ProgressBar.ShowPercentage` это `true`.
`background` `StyleBox`	Стиль фона.
`fill` `StyleBox`	Стиль прогресса (То есть та часть, которая заполняет полосу).