#### [PromptPlus](PromptPlus.md 'PromptPlus') ### [PromptPlusLibrary](PromptPlusLibrary.md 'PromptPlusLibrary') ## StateProgress Struct Represents the final state of a Progress Bar control execution\. ```csharp public readonly struct StateProgress ``` ### Constructors ## StateProgress\(double, string, double, double, TimeSpan, IReadOnlyDictionary\, Exception\) Constructor Represents the final state of a Progress Bar control execution\. ```csharp public StateProgress(double value, string? valuetext, double minvalue, double maxvalue, System.TimeSpan elapsedtime, System.Collections.Generic.IReadOnlyDictionary? resultcontext=null, System.Exception? error=null); ``` #### Parameters `value` [System\.Double](https://learn.microsoft.com/en-us/dotnet/api/system.double 'System\.Double') Final numeric value\. `valuetext` [System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String') Final display text\. `minvalue` [System\.Double](https://learn.microsoft.com/en-us/dotnet/api/system.double 'System\.Double') Configured minimum value\. `maxvalue` [System\.Double](https://learn.microsoft.com/en-us/dotnet/api/system.double 'System\.Double') Configured maximum value\. `elapsedtime` [System\.TimeSpan](https://learn.microsoft.com/en-us/dotnet/api/system.timespan 'System\.TimeSpan') Total elapsed execution time\. `resultcontext` [System\.Collections\.Generic\.IReadOnlyDictionary<](https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2 'System\.Collections\.Generic\.IReadOnlyDictionary\`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.ireadonlydictionary-2 'System\.Collections\.Generic\.IReadOnlyDictionary\`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.ireadonlydictionary-2 'System\.Collections\.Generic\.IReadOnlyDictionary\`2') Optional output context values\. `error` [System\.Exception](https://learn.microsoft.com/en-us/dotnet/api/system.exception 'System\.Exception') Captured exception, if any\. ### Properties ## StateProgress\.ElapsedTime Property Gets the total elapsed time\. ```csharp public System.TimeSpan ElapsedTime { get; } ``` #### Property Value [System\.TimeSpan](https://learn.microsoft.com/en-us/dotnet/api/system.timespan 'System\.TimeSpan') ## StateProgress\.ExceptionProgress Property Gets the captured exception, if one occurred\. ```csharp public System.Exception? ExceptionProgress { get; } ``` #### Property Value [System\.Exception](https://learn.microsoft.com/en-us/dotnet/api/system.exception 'System\.Exception') ## StateProgress\.FinishedText Property Gets the final display text\. ```csharp public string? FinishedText { get; } ``` #### Property Value [System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String') ## StateProgress\.FinishedValue Property Gets the final numeric value\. ```csharp public System.Nullable FinishedValue { get; } ``` #### Property Value [System\.Nullable<](https://learn.microsoft.com/en-us/dotnet/api/system.nullable-1 'System\.Nullable\`1')[System\.Double](https://learn.microsoft.com/en-us/dotnet/api/system.double 'System\.Double')[>](https://learn.microsoft.com/en-us/dotnet/api/system.nullable-1 'System\.Nullable\`1') ## StateProgress\.MaxValue Property Gets the configured maximum value\. ```csharp public double MaxValue { get; } ``` #### Property Value [System\.Double](https://learn.microsoft.com/en-us/dotnet/api/system.double 'System\.Double') ## StateProgress\.MinValue Property Gets the configured minimum value\. ```csharp public double MinValue { get; } ``` #### Property Value [System\.Double](https://learn.microsoft.com/en-us/dotnet/api/system.double 'System\.Double') ## StateProgress\.OutputContext Property Gets optional output context values\. ```csharp public System.Collections.Generic.IReadOnlyDictionary? OutputContext { get; } ``` #### Property Value [System\.Collections\.Generic\.IReadOnlyDictionary<](https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2 'System\.Collections\.Generic\.IReadOnlyDictionary\`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.ireadonlydictionary-2 'System\.Collections\.Generic\.IReadOnlyDictionary\`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.ireadonlydictionary-2 'System\.Collections\.Generic\.IReadOnlyDictionary\`2') ### Methods ## StateProgress\.GetOutput\\(string, bool\) Method Tries to read an output context value and cast it to [T](StateProgress.md#PromptPlusLibrary.StateProgress.GetOutput_T_(string,bool).T 'PromptPlusLibrary\.StateProgress\.GetOutput\\(string, bool\)\.T')\. ```csharp public T GetOutput(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') Output 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](StateProgress.md#PromptPlusLibrary.StateProgress.GetOutput_T_(string,bool).T 'PromptPlusLibrary\.StateProgress\.GetOutput\\(string, bool\)\.T'); otherwise, `false`\. #### Returns [T](StateProgress.md#PromptPlusLibrary.StateProgress.GetOutput_T_(string,bool).T 'PromptPlusLibrary\.StateProgress\.GetOutput\\(string, bool\)\.T') The typed value when found; otherwise, `default`\.