Class ProgressItem

Class representing a progress bar in the plugin UI.

Inheritance
System.Object
ProgressItem
Namespace: Emby.Web.GenericEdit.Elements
Assembly: Emby.Web.GenericEdit.dll
Syntax
public class ProgressItem

Constructors

ProgressItem()

Initializes a new instance of the ProgressItem class.

Declaration
public ProgressItem()

ProgressItem(Int32, Int32, String)

Initializes a new instance of the ProgressItem class.

Declaration
public ProgressItem(int currentValue, int maxValue, string progressText)
Parameters
Type Name Description
System.Int32 currentValue

The current value.
System.Int32 maxValue

The maximum value.
System.String progressText

The progress text.

Properties

CurrentValue

Gets or sets the current value.

Declaration
public int CurrentValue { get; set; }
Property Value
Type Description
System.Int32

The current value.
Remarks

This indicates the current state of progress. If set to 0, the bar is shown empty across the full range. If set to MaxValue, the bar is shown filled across the full range.

MaxValue

Gets or sets the maximum value.

Declaration
public int MaxValue { get; set; }
Property Value
Type Description
System.Int32

The maximum value.
Remarks

This value represents the 100% position. When CurrentValue reaches this value, the progress bar will be filled across the full range.

ProgressText

Gets or sets the progress text.

Declaration
public string ProgressText { get; set; }
Property Value
Type Description
System.String

The progress text.
Remarks

If specified, a label will be shown with the given text.

Extension Methods