ProgressBar — C# API

class ProgressBarReckfellSharpInherits Range

For a known workload, set MinValue, MaxValue and Value; for example, 0, 200 and 50 mean 25%, not 50%. Your code updates the value: ProgressBar does not track loading automatically. Defaults are Step = 0.01, ShowPercentage = true and Indeterminate = false. Do not block the main thread with a long task or the interface cannot update.

FillMode selects direction. BeginToEnd/EndToBegin respect RTL; vertical modes run top to bottom or bottom to top. Theme resources background/fill define colors and shape. Percentages use the entire MinValue…MaxValue range; Page reduces reachable Value, so normally leave Page = 0.

Indeterminate = true shows a moving waiting segment without a percentage or computing Value. ShowPercentage can remain true in stored settings, but its text is not drawn. Returning to determinate mode retains Value. EditorPreviewIndeterminate controls animation only in the edited level, not in the running game.

AllowGreater/AllowLesser can permit percentage labels outside 0…100%, while ordinary fill geometry uses clamped Ratio. Leave these permissions off for a conventional completion indicator.

Range.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

ProgressBarConstructor

# ProgressBar

C#
public ProgressBar();

Creates an indicator with Step = 0.01, ShowPercentage = true, Indeterminate = false and BeginToEnd direction. Your code supplies workload and Value.

Properties4

EditorPreviewIndeterminateProperty

# EditorPreviewIndeterminate

C#
public bool EditorPreviewIndeterminate { get; set; }

Enables Indeterminate animation in the edited level, default false. Does not control running-game animation and is not a speed setting.

FillModeProperty

# FillMode

C#
public int FillMode { get; set; }

Fill direction, default BeginToEnd. Use ProgressBar.FillModeEnum values cast to int: BeginToEnd, EndToBegin, TopToBottom, BottomToTop. Horizontal modes respect RTL.

IndeterminateProperty

# Indeterminate

C#
public bool Indeterminate { get; set; }

Waiting mode without a known fraction, default false. Enables internal animation while the interface runs, without computing or changing Value. Percentage text is not drawn; disabling retains Value.

ShowPercentageProperty

# ShowPercentage

C#
public bool ShowPercentage { get; set; }

Show a percentage label, default true. Fraction uses MinValue…MaxValue. Indeterminate mode does not draw the label even if the stored setting is true; Value is unchanged.

Methods8

GetFillModeint

# GetFillMode

C#
public int GetFillMode();

Fill direction, default BeginToEnd. Use ProgressBar.FillModeEnum values cast to int: BeginToEnd, EndToBegin, TopToBottom, BottomToTop. Horizontal modes respect RTL.

Returns int

Current setting rather than confirmation of input or visual validation.

IsEditorPreviewIndeterminateEnabledbool

# IsEditorPreviewIndeterminateEnabled

C#
public bool IsEditorPreviewIndeterminateEnabled();

Enables Indeterminate animation in the edited level, default false. Does not control running-game animation and is not a speed setting.

Returns bool

Current setting rather than confirmation of input or visual validation.

IsIndeterminatebool

# IsIndeterminate

C#
public bool IsIndeterminate();

Waiting mode without a known fraction, default false. Enables internal animation while the interface runs, without computing or changing Value. Percentage text is not drawn; disabling retains Value.

Returns bool

Current setting rather than confirmation of input or visual validation.

IsPercentageShownbool

# IsPercentageShown

C#
public bool IsPercentageShown();

Show a percentage label, default true. Fraction uses MinValue…MaxValue. Indeterminate mode does not draw the label even if the stored setting is true; Value is unchanged.

Returns bool

Current setting rather than confirmation of input or visual validation.

SetEditorPreviewIndeterminatevoid

# SetEditorPreviewIndeterminate

C#
public void SetEditorPreviewIndeterminate(bool previewIndeterminate);

Enables Indeterminate animation in the edited level, default false. Does not control running-game animation and is not a speed setting.

Parameters
Name	Type	Default
`previewIndeterminate`	`bool`	—

previewIndeterminate

Enables Indeterminate animation in the edited level, default false. Does not control running-game animation and is not a speed setting.

SetFillModevoid

# SetFillMode

C#
public void SetFillMode(int mode);

Fill direction, default BeginToEnd. Use ProgressBar.FillModeEnum values cast to int: BeginToEnd, EndToBegin, TopToBottom, BottomToTop. Horizontal modes respect RTL.

Parameters
Name	Type	Default
`mode`	`int`	—

mode

Fill direction, default BeginToEnd. Use ProgressBar.FillModeEnum values cast to int: BeginToEnd, EndToBegin, TopToBottom, BottomToTop. Horizontal modes respect RTL.

SetIndeterminatevoid

# SetIndeterminate

C#
public void SetIndeterminate(bool indeterminate);

Waiting mode without a known fraction, default false. Enables internal animation while the interface runs, without computing or changing Value. Percentage text is not drawn; disabling retains Value.

Parameters
Name	Type	Default
`indeterminate`	`bool`	—

indeterminate

Waiting mode without a known fraction, default false. Enables internal animation while the interface runs, without computing or changing Value. Percentage text is not drawn; disabling retains Value.

SetShowPercentagevoid

# SetShowPercentage

C#
public void SetShowPercentage(bool visible);

Show a percentage label, default true. Fraction uses MinValue…MaxValue. Indeterminate mode does not draw the label even if the stored setting is true; Value is unchanged.

Parameters
Name	Type	Default
`visible`	`bool`	—

visible

Show a percentage label, default true. Fraction uses MinValue…MaxValue. Indeterminate mode does not draw the label even if the stored setting is true; Value is unchanged.

ProgressBar.FillModeEnum

Value	Description
`BeginToEnd = 0`	The progress bar fills from begin to end horizontally, according to the language direction. If `Control.IsLayoutRtl` returns `false`, it fills from left to right, and if it returns `true`, it fills from right to left.
`BottomToTop = 3`	The progress fills from bottom to top.
`EndToBegin = 1`	The progress bar fills from end to begin horizontally, according to the language direction. If `Control.IsLayoutRtl` returns `false`, it fills from right to left, and if it returns `true`, it fills from left to right.
`TopToBottom = 2`	The progress fills from top to bottom.

Theme properties

These are Theme resource keys, not C# properties. Use the matching Control GetTheme…() and AddTheme…Override() methods for each value type.

Key and type	Description
`font_color` `Color`	The color of the text. Default: `Color(0.95, 0.95, 0.95, 1)`
`font_outline_color` `Color`	The tint of text outline of the `ProgressBar`. Default: `Color(0, 0, 0, 1)`
`outline_size` `int`	The size of the text outline. Note: If using a font with `FontFile.MultichannelSignedDistanceField` enabled, its `FontFile.MsdfPixelRange` must be set to at least twice the value of `ProgressBar.outline_size` for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended. Default: `0`
`font` `Font`	Font used to draw the fill percentage if `ProgressBar.ShowPercentage` is `true`.
`font_size` `int`	Font size used to draw the fill percentage if `ProgressBar.ShowPercentage` is `true`.
`background` `StyleBox`	The style of the background.
`fill` `StyleBox`	The style of the progress (i.e. the part that fills the bar).