#### [PromptPlus](PromptPlus.md 'PromptPlus') ### [PromptPlusLibrary](PromptPlusLibrary.md 'PromptPlusLibrary') ## ProgressBarEvent Class Represents the mutable state used by ProgressBar update callbacks\. ```csharp public sealed class ProgressBarEvent ``` Inheritance [System\.Object](https://learn.microsoft.com/en-us/dotnet/api/system.object 'System\.Object') → ProgressBarEvent ### Constructors ## ProgressBarEvent\(double, double, double, IDictionary\\) Constructor Initializes a new [ProgressBarEvent](ProgressBarEvent.md 'PromptPlusLibrary\.ProgressBarEvent') instance\. ```csharp public ProgressBarEvent(double value, double min, double max, System.Collections.Generic.IDictionary? paramcontext=null); ``` #### Parameters `value` [System\.Double](https://learn.microsoft.com/en-us/dotnet/api/system.double 'System\.Double') Initial progress value\. `min` [System\.Double](https://learn.microsoft.com/en-us/dotnet/api/system.double 'System\.Double') Minimum allowed progress value\. `max` [System\.Double](https://learn.microsoft.com/en-us/dotnet/api/system.double 'System\.Double') Maximum allowed progress value\. `paramcontext` [System\.Collections\.Generic\.IDictionary<](https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2 'System\.Collections\.Generic\.IDictionary\`2')[System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String')[,](https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2 'System\.Collections\.Generic\.IDictionary\`2')[System\.Object](https://learn.microsoft.com/en-us/dotnet/api/system.object 'System\.Object')[>](https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2 'System\.Collections\.Generic\.IDictionary\`2') Optional input context available to the callback\. #### Exceptions [System\.ArgumentException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentexception 'System\.ArgumentException') Thrown when [min](ProgressBarEvent.md#PromptPlusLibrary.ProgressBarEvent.ProgressBarEvent(double,double,double,System.Collections.Generic.IDictionary_string,object_).min 'PromptPlusLibrary\.ProgressBarEvent\.ProgressBarEvent\(double, double, double, System\.Collections\.Generic\.IDictionary\\)\.min') is greater than or equal to [max](ProgressBarEvent.md#PromptPlusLibrary.ProgressBarEvent.ProgressBarEvent(double,double,double,System.Collections.Generic.IDictionary_string,object_).max 'PromptPlusLibrary\.ProgressBarEvent\.ProgressBarEvent\(double, double, double, System\.Collections\.Generic\.IDictionary\\)\.max')\. [System\.ArgumentOutOfRangeException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentoutofrangeexception 'System\.ArgumentOutOfRangeException') Thrown when [value](ProgressBarEvent.md#PromptPlusLibrary.ProgressBarEvent.ProgressBarEvent(double,double,double,System.Collections.Generic.IDictionary_string,object_).value 'PromptPlusLibrary\.ProgressBarEvent\.ProgressBarEvent\(double, double, double, System\.Collections\.Generic\.IDictionary\\)\.value') is outside the [min](ProgressBarEvent.md#PromptPlusLibrary.ProgressBarEvent.ProgressBarEvent(double,double,double,System.Collections.Generic.IDictionary_string,object_).min 'PromptPlusLibrary\.ProgressBarEvent\.ProgressBarEvent\(double, double, double, System\.Collections\.Generic\.IDictionary\\)\.min')/[max](ProgressBarEvent.md#PromptPlusLibrary.ProgressBarEvent.ProgressBarEvent(double,double,double,System.Collections.Generic.IDictionary_string,object_).max 'PromptPlusLibrary\.ProgressBarEvent\.ProgressBarEvent\(double, double, double, System\.Collections\.Generic\.IDictionary\\)\.max') range\. ### Properties ## ProgressBarEvent\.Error Property Gets the error that caused an abort, if any\. ```csharp public System.Exception? Error { get; } ``` #### Property Value [System\.Exception](https://learn.microsoft.com/en-us/dotnet/api/system.exception 'System\.Exception') ## ProgressBarEvent\.Finish Property Gets whether processing has completed \(aborted or reached max value\)\. ```csharp public bool Finish { get; } ``` #### Property Value [System\.Boolean](https://learn.microsoft.com/en-us/dotnet/api/system.boolean 'System\.Boolean') ## ProgressBarEvent\.Maxvalue Property Gets the maximum progress value\. ```csharp public double Maxvalue { get; } ``` #### Property Value [System\.Double](https://learn.microsoft.com/en-us/dotnet/api/system.double 'System\.Double') ## ProgressBarEvent\.Minvalue Property Gets the minimum progress value\. ```csharp public double Minvalue { get; } ``` #### Property Value [System\.Double](https://learn.microsoft.com/en-us/dotnet/api/system.double 'System\.Double') ## ProgressBarEvent\.OutputContext Property Gets the output context produced during handler execution\. ```csharp public System.Collections.ObjectModel.ReadOnlyDictionary OutputContext { get; } ``` #### Property Value [System\.Collections\.ObjectModel\.ReadOnlyDictionary<](https://learn.microsoft.com/en-us/dotnet/api/system.collections.objectmodel.readonlydictionary-2 'System\.Collections\.ObjectModel\.ReadOnlyDictionary\`2')[System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String')[,](https://learn.microsoft.com/en-us/dotnet/api/system.collections.objectmodel.readonlydictionary-2 'System\.Collections\.ObjectModel\.ReadOnlyDictionary\`2')[System\.Object](https://learn.microsoft.com/en-us/dotnet/api/system.object 'System\.Object')[>](https://learn.microsoft.com/en-us/dotnet/api/system.collections.objectmodel.readonlydictionary-2 'System\.Collections\.ObjectModel\.ReadOnlyDictionary\`2') ## ProgressBarEvent\.Value Property Gets the current progress value\. ```csharp public double Value { get; } ``` #### Property Value [System\.Double](https://learn.microsoft.com/en-us/dotnet/api/system.double 'System\.Double') ### Methods ## ProgressBarEvent\.AddOutputContext\\(string, T\) Method Adds or updates an output context entry\. ```csharp public void AddOutputContext(string key, T value); ``` #### Type parameters `T` #### Parameters `key` [System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String') Output context key\. `value` [T](ProgressBarEvent.md#PromptPlusLibrary.ProgressBarEvent.AddOutputContext_T_(string,T).T 'PromptPlusLibrary\.ProgressBarEvent\.AddOutputContext\\(string, T\)\.T') Value associated with [key](ProgressBarEvent.md#PromptPlusLibrary.ProgressBarEvent.AddOutputContext_T_(string,T).key 'PromptPlusLibrary\.ProgressBarEvent\.AddOutputContext\\(string, T\)\.key')\. ## ProgressBarEvent\.ErrorAndAbort\(Exception\) Method Stores an error and aborts further processing\. ```csharp public void ErrorAndAbort(System.Exception? error); ``` #### Parameters `error` [System\.Exception](https://learn.microsoft.com/en-us/dotnet/api/system.exception 'System\.Exception') Associated error\. Can be `null`\. ## ProgressBarEvent\.HasChange\(\) Method Indicates whether state changed since the previous check\. ```csharp public bool HasChange(); ``` #### Returns [System\.Boolean](https://learn.microsoft.com/en-us/dotnet/api/system.boolean 'System\.Boolean') `true` when aborted or when the value changed; otherwise, `false`\. ## ProgressBarEvent\.InputParam\\(string, bool\) Method Tries to read an input context value and cast it to [T](ProgressBarEvent.md#PromptPlusLibrary.ProgressBarEvent.InputParam_T_(string,bool).T 'PromptPlusLibrary\.ProgressBarEvent\.InputParam\\(string, bool\)\.T')\. ```csharp public T InputParam(string key, out bool found); ``` #### Type parameters `T` Expected value type\. #### Parameters `key` [System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String') Input context key\. `found` [System\.Boolean](https://learn.microsoft.com/en-us/dotnet/api/system.boolean 'System\.Boolean') `true` when the key exists and the value matches [T](ProgressBarEvent.md#PromptPlusLibrary.ProgressBarEvent.InputParam_T_(string,bool).T 'PromptPlusLibrary\.ProgressBarEvent\.InputParam\\(string, bool\)\.T'); otherwise, `false`\. #### Returns [T](ProgressBarEvent.md#PromptPlusLibrary.ProgressBarEvent.InputParam_T_(string,bool).T 'PromptPlusLibrary\.ProgressBarEvent\.InputParam\\(string, bool\)\.T') The typed value when found; otherwise, `default`\. ## ProgressBarEvent\.RemoveOutputContext\(string\) Method Removes an output context entry by key\. ```csharp public void RemoveOutputContext(string key); ``` #### Parameters `key` [System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String') Output context key\. ## ProgressBarEvent\.Update\(double\) Method Updates the current value, clamped to the configured range\. ```csharp public void Update(double value); ``` #### Parameters `value` [System\.Double](https://learn.microsoft.com/en-us/dotnet/api/system.double 'System\.Double') New progress value\.