#### [PromptPlus](PromptPlus.md 'PromptPlus') ### [PromptPlusLibrary](PromptPlusLibrary.md 'PromptPlusLibrary') ## IProgressBarControl Interface Provides a fluent API for configuring and running a ProgressBar control that drives a visual progress indicator from an external update\-handler callback, displaying the current value, an optional spinner, and an optional description that all update in real time\. ```csharp public interface IProgressBarControl ``` ### Remarks The progress value is updated by the callback registered via [UpdateHandler\(Action<ProgressBarEvent,CancellationToken>, IDictionary<string,object>\)](IProgressBarControl.md#PromptPlusLibrary.IProgressBarControl.UpdateHandler(System.Action_PromptPlusLibrary.ProgressBarEvent,System.Threading.CancellationToken_,System.Collections.Generic.IDictionary_string,object_) 'PromptPlusLibrary\.IProgressBarControl\.UpdateHandler\(System\.Action\, System\.Collections\.Generic\.IDictionary\\)') or its async variant\. When the callback reports completion \(or the cancellation token is signalled\) the control returns the final [StateProgress](StateProgress.md 'PromptPlusLibrary\.StateProgress')\. Every configuration method returns the same [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') instance so the calls can be chained \(fluent style\)\. Call [Run\(CancellationToken\)](IProgressBarControl.md#PromptPlusLibrary.IProgressBarControl.Run(System.Threading.CancellationToken) 'PromptPlusLibrary\.IProgressBarControl\.Run\(System\.Threading\.CancellationToken\)') last\. ### Methods ## IProgressBarControl\.ChangeColor\(Func\\) Method Registers a callback that returns a [ConsolePlusLibrary\.Style](https://learn.microsoft.com/en-us/dotnet/api/consolepluslibrary.style 'ConsolePlusLibrary\.Style') based on the current progress value, so the bar color changes dynamically as the value advances\. ```csharp PromptPlusLibrary.IProgressBarControl ChangeColor(System.Func value); ``` #### Parameters `value` [System\.Func<](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2')[System\.Double](https://learn.microsoft.com/en-us/dotnet/api/system.double 'System\.Double')[,](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2')[ConsolePlusLibrary\.Style](https://learn.microsoft.com/en-us/dotnet/api/consolepluslibrary.style 'ConsolePlusLibrary\.Style')[>](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2') A function that receives the current numeric value and returns the style to apply\. Cannot be `null`\. #### Returns [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') The current [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown when [value](IProgressBarControl.md#PromptPlusLibrary.IProgressBarControl.ChangeColor(System.Func_double,ConsolePlusLibrary.Style_).value 'PromptPlusLibrary\.IProgressBarControl\.ChangeColor\(System\.Func\\)\.value') is `null`\. ## IProgressBarControl\.ChangeDescription\(Func\\) Method Registers a callback that provides a dynamic description text based on the current progress value; the description is refreshed every time the value changes\. ```csharp PromptPlusLibrary.IProgressBarControl ChangeDescription(System.Func value); ``` #### Parameters `value` [System\.Func<](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2')[System\.Double](https://learn.microsoft.com/en-us/dotnet/api/system.double 'System\.Double')[,](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2')[System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String')[>](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2') A function that receives the current numeric value and returns the description to display\. Cannot be `null`\. #### Returns [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') The current [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown when [value](IProgressBarControl.md#PromptPlusLibrary.IProgressBarControl.ChangeDescription(System.Func_double,string_).value 'PromptPlusLibrary\.IProgressBarControl\.ChangeDescription\(System\.Func\\)\.value') is `null`\. ## IProgressBarControl\.ChangeDescriptionAsync\(Func\\>\) Method Asynchronous variant of [ChangeDescription\(Func<double,string>\)](IProgressBarControl.md#PromptPlusLibrary.IProgressBarControl.ChangeDescription(System.Func_double,string_) 'PromptPlusLibrary\.IProgressBarControl\.ChangeDescription\(System\.Func\\)')\. The task is awaited synchronously each time the description is refreshed\. ```csharp PromptPlusLibrary.IProgressBarControl ChangeDescriptionAsync(System.Func> value); ``` #### Parameters `value` [System\.Func<](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2')[System\.Double](https://learn.microsoft.com/en-us/dotnet/api/system.double 'System\.Double')[,](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2')[System\.Threading\.Tasks\.Task<](https://learn.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1 'System\.Threading\.Tasks\.Task\`1')[System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String')[>](https://learn.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1 'System\.Threading\.Tasks\.Task\`1')[>](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2') An async callback that receives the current numeric value and returns the description\. Cannot be `null`\. #### Returns [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') The current [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown when [value](IProgressBarControl.md#PromptPlusLibrary.IProgressBarControl.ChangeDescriptionAsync(System.Func_double,System.Threading.Tasks.Task_string__).value 'PromptPlusLibrary\.IProgressBarControl\.ChangeDescriptionAsync\(System\.Func\\>\)\.value') is `null`\. ## IProgressBarControl\.ChangeGradient\(Color\[\]\) Method Applies a gradient color sequence to the filled portion of the bar\. The gradient is interpolated across the configured range as the value advances\. ```csharp PromptPlusLibrary.IProgressBarControl ChangeGradient(params ConsolePlusLibrary.Color[] colors); ``` #### Parameters `colors` [ConsolePlusLibrary\.Color](https://learn.microsoft.com/en-us/dotnet/api/consolepluslibrary.color 'ConsolePlusLibrary\.Color')[\[\]](https://learn.microsoft.com/en-us/dotnet/api/system.array 'System\.Array') Two or more [ConsolePlusLibrary\.Color](https://learn.microsoft.com/en-us/dotnet/api/consolepluslibrary.color 'ConsolePlusLibrary\.Color') values that define the gradient\. Cannot be `null` or empty\. #### Returns [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') The current [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown when [colors](IProgressBarControl.md#PromptPlusLibrary.IProgressBarControl.ChangeGradient(ConsolePlusLibrary.Color[]).colors 'PromptPlusLibrary\.IProgressBarControl\.ChangeGradient\(ConsolePlusLibrary\.Color\[\]\)\.colors') is `null` or empty\. ## IProgressBarControl\.Culture\(string\) Method Sets the culture used to format numeric values by culture name\. ```csharp PromptPlusLibrary.IProgressBarControl Culture(string cultureName); ``` #### Parameters `cultureName` [System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String') The name of the [System\.Globalization\.CultureInfo](https://learn.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo 'System\.Globalization\.CultureInfo') to use\. Cannot be `null` or empty\. #### Returns [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') The current [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') instance for chaining\. #### Exceptions [System\.ArgumentException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentexception 'System\.ArgumentException') Thrown when [cultureName](IProgressBarControl.md#PromptPlusLibrary.IProgressBarControl.Culture(string).cultureName 'PromptPlusLibrary\.IProgressBarControl\.Culture\(string\)\.cultureName') is `null` or empty\. [System\.Globalization\.CultureNotFoundException](https://learn.microsoft.com/en-us/dotnet/api/system.globalization.culturenotfoundexception 'System\.Globalization\.CultureNotFoundException') Thrown when the specified culture name is not valid\. ## IProgressBarControl\.Culture\(CultureInfo\) Method Sets the culture used to format numeric values\. ```csharp PromptPlusLibrary.IProgressBarControl Culture(System.Globalization.CultureInfo culture); ``` #### Parameters `culture` [System\.Globalization\.CultureInfo](https://learn.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo 'System\.Globalization\.CultureInfo') The [System\.Globalization\.CultureInfo](https://learn.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo 'System\.Globalization\.CultureInfo') to use\. Cannot be `null`\. #### Returns [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') The current [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown when [culture](IProgressBarControl.md#PromptPlusLibrary.IProgressBarControl.Culture(System.Globalization.CultureInfo).culture 'PromptPlusLibrary\.IProgressBarControl\.Culture\(System\.Globalization\.CultureInfo\)\.culture') is `null`\. ## IProgressBarControl\.Default\(double\) Method Sets the initial ProgressBar value\. Default is 0\. ```csharp PromptPlusLibrary.IProgressBarControl Default(double value); ``` #### Parameters `value` [System\.Double](https://learn.microsoft.com/en-us/dotnet/api/system.double 'System\.Double') The initial value\. #### Returns [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') The current [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') instance for chaining\. #### Exceptions [System\.ArgumentOutOfRangeException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentoutofrangeexception 'System\.ArgumentOutOfRangeException') Thrown when [value](IProgressBarControl.md#PromptPlusLibrary.IProgressBarControl.Default(double).value 'PromptPlusLibrary\.IProgressBarControl\.Default\(double\)\.value') is outside the configured range\. ## IProgressBarControl\.Fill\(ProgressBarType\) Method Sets the visual fill style of the progress bar track\. Default is [Fill](ProgressBarType.md#PromptPlusLibrary.ProgressBarType.Fill 'PromptPlusLibrary\.ProgressBarType\.Fill')\. ```csharp PromptPlusLibrary.IProgressBarControl Fill(PromptPlusLibrary.ProgressBarType type); ``` #### Parameters `type` [ProgressBarType](ProgressBarType.md 'PromptPlusLibrary\.ProgressBarType') The fill style to use\. #### Returns [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') The current [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') instance for chaining\. ## IProgressBarControl\.Finish\(string\) Method Sets the text displayed when the ProgressBar completes\. ```csharp PromptPlusLibrary.IProgressBarControl Finish(string finishtext); ``` #### Parameters `finishtext` [System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String') Completion text\. #### Returns [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') The current [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') instance for chaining\. ## IProgressBarControl\.FractionalDigits\(byte\) Method Sets the number of fractional digits shown for values\. Default is 0\. ```csharp PromptPlusLibrary.IProgressBarControl FractionalDigits(byte value); ``` #### Parameters `value` [System\.Byte](https://learn.microsoft.com/en-us/dotnet/api/system.byte 'System\.Byte') The number of fractional digits\. #### Returns [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') The current [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') instance for chaining\. #### Exceptions [System\.ArgumentOutOfRangeException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentoutofrangeexception 'System\.ArgumentOutOfRangeException') Thrown when [value](IProgressBarControl.md#PromptPlusLibrary.IProgressBarControl.FractionalDigits(byte).value 'PromptPlusLibrary\.IProgressBarControl\.FractionalDigits\(byte\)\.value') is greater than 5\. ## IProgressBarControl\.HideElements\(HideProgressBar\) Method Hides one or more visual elements of the ProgressBar \(e\.g\. the value label or the percentage\)\. ```csharp PromptPlusLibrary.IProgressBarControl HideElements(PromptPlusLibrary.HideProgressBar value); ``` #### Parameters `value` [HideProgressBar](HideProgressBar.md 'PromptPlusLibrary\.HideProgressBar') A [HideProgressBar](HideProgressBar.md 'PromptPlusLibrary\.HideProgressBar') flags value identifying the elements to hide\. #### Returns [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') The current [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') instance for chaining\. ## IProgressBarControl\.Options\(Action\\) Method Applies shared control options \(such as prompt text, tooltip visibility, and abort behavior\)\. ```csharp PromptPlusLibrary.IProgressBarControl Options(System.Action options); ``` #### Parameters `options` [System\.Action<](https://learn.microsoft.com/en-us/dotnet/api/system.action-1 'System\.Action\`1')[IControlOptions](IControlOptions.md 'PromptPlusLibrary\.IControlOptions')[>](https://learn.microsoft.com/en-us/dotnet/api/system.action-1 'System\.Action\`1') A callback used to configure the [IControlOptions](IControlOptions.md 'PromptPlusLibrary\.IControlOptions')\. Cannot be `null`\. #### Returns [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') The current [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown when [options](IProgressBarControl.md#PromptPlusLibrary.IProgressBarControl.Options(System.Action_PromptPlusLibrary.IControlOptions_).options 'PromptPlusLibrary\.IProgressBarControl\.Options\(System\.Action\\)\.options') is `null`\. ## IProgressBarControl\.Range\(double, double\) Method Sets the valid numeric range for the ProgressBar\. ```csharp PromptPlusLibrary.IProgressBarControl Range(double minvalue, double maxvalue); ``` #### Parameters `minvalue` [System\.Double](https://learn.microsoft.com/en-us/dotnet/api/system.double 'System\.Double') Minimum allowed value\. `maxvalue` [System\.Double](https://learn.microsoft.com/en-us/dotnet/api/system.double 'System\.Double') Maximum allowed value\. #### Returns [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') The current [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') instance for chaining\. #### Exceptions [System\.ArgumentOutOfRangeException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentoutofrangeexception 'System\.ArgumentOutOfRangeException') Thrown when [minvalue](IProgressBarControl.md#PromptPlusLibrary.IProgressBarControl.Range(double,double).minvalue 'PromptPlusLibrary\.IProgressBarControl\.Range\(double, double\)\.minvalue') is greater than or equal to [maxvalue](IProgressBarControl.md#PromptPlusLibrary.IProgressBarControl.Range(double,double).maxvalue 'PromptPlusLibrary\.IProgressBarControl\.Range\(double, double\)\.maxvalue')\. ## IProgressBarControl\.Run\(CancellationToken\) Method Displays the ProgressBar control and blocks until the update\-handler signals completion or the cancellation token is triggered, returning the final state\. ```csharp PromptPlusLibrary.ResultPrompt Run(System.Threading.CancellationToken token=default(System.Threading.CancellationToken)); ``` #### Parameters `token` [System\.Threading\.CancellationToken](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken 'System\.Threading\.CancellationToken') A [System\.Threading\.CancellationToken](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken 'System\.Threading\.CancellationToken') used to cancel the operation\. Defaults to [System\.Threading\.CancellationToken\.None](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken.none 'System\.Threading\.CancellationToken\.None')\. #### Returns [PromptPlusLibrary\.ResultPrompt<](ResultPrompt_T_.md 'PromptPlusLibrary\.ResultPrompt\')[StateProgress](StateProgress.md 'PromptPlusLibrary\.StateProgress')[>](ResultPrompt_T_.md 'PromptPlusLibrary\.ResultPrompt\') A [ResultPrompt<T>](ResultPrompt_T_.md 'PromptPlusLibrary\.ResultPrompt\') containing the final [StateProgress](StateProgress.md 'PromptPlusLibrary\.StateProgress')\. ## IProgressBarControl\.Spinner\(SpinnersType\) Method Displays an animated spinner alongside the progress bar while the operation is running\. ```csharp PromptPlusLibrary.IProgressBarControl Spinner(PromptPlusLibrary.SpinnersType spinnersType); ``` #### Parameters `spinnersType` [SpinnersType](SpinnersType.md 'PromptPlusLibrary\.SpinnersType') The [SpinnersType](SpinnersType.md 'PromptPlusLibrary\.SpinnersType') to display\. #### Returns [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') The current [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') instance for chaining\. ## IProgressBarControl\.Styles\(ProgressBarStyles, Style\) Method Overrides the visual style applied to a specific region of the ProgressBar control\. ```csharp PromptPlusLibrary.IProgressBarControl Styles(PromptPlusLibrary.ProgressBarStyles styleType, ConsolePlusLibrary.Style style); ``` #### Parameters `styleType` [ProgressBarStyles](ProgressBarStyles.md 'PromptPlusLibrary\.ProgressBarStyles') The [ProgressBarStyles](ProgressBarStyles.md 'PromptPlusLibrary\.ProgressBarStyles') region whose style is overridden\. `style` [ConsolePlusLibrary\.Style](https://learn.microsoft.com/en-us/dotnet/api/consolepluslibrary.style 'ConsolePlusLibrary\.Style') The [ConsolePlusLibrary\.Style](https://learn.microsoft.com/en-us/dotnet/api/consolepluslibrary.style 'ConsolePlusLibrary\.Style') to apply\. #### Returns [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') The current [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') instance for chaining\. ## IProgressBarControl\.UpdateHandler\(Action\, IDictionary\\) Method Sets a synchronous callback to update ProgressBar values during execution\. ```csharp PromptPlusLibrary.IProgressBarControl UpdateHandler(System.Action value, System.Collections.Generic.IDictionary? context=null); ``` #### Parameters `value` [System\.Action<](https://learn.microsoft.com/en-us/dotnet/api/system.action-2 'System\.Action\`2')[ProgressBarEvent](ProgressBarEvent.md 'PromptPlusLibrary\.ProgressBarEvent')[,](https://learn.microsoft.com/en-us/dotnet/api/system.action-2 'System\.Action\`2')[System\.Threading\.CancellationToken](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken 'System\.Threading\.CancellationToken')[>](https://learn.microsoft.com/en-us/dotnet/api/system.action-2 'System\.Action\`2') Callback that receives [ProgressBarEvent](ProgressBarEvent.md 'PromptPlusLibrary\.ProgressBarEvent') and [System\.Threading\.CancellationToken](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken 'System\.Threading\.CancellationToken')\. Cannot be `null`\. `context` [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 key/value context data passed to the callback\. #### Returns [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') The current [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown when [value](IProgressBarControl.md#PromptPlusLibrary.IProgressBarControl.UpdateHandler(System.Action_PromptPlusLibrary.ProgressBarEvent,System.Threading.CancellationToken_,System.Collections.Generic.IDictionary_string,object_).value 'PromptPlusLibrary\.IProgressBarControl\.UpdateHandler\(System\.Action\, System\.Collections\.Generic\.IDictionary\\)\.value') is `null`\. ## IProgressBarControl\.UpdateHandlerAsync\(Func\, IDictionary\\) Method Sets an asynchronous callback to update ProgressBar values during execution\. ```csharp PromptPlusLibrary.IProgressBarControl UpdateHandlerAsync(System.Func value, System.Collections.Generic.IDictionary? context=null); ``` #### Parameters `value` [System\.Func<](https://learn.microsoft.com/en-us/dotnet/api/system.func-3 'System\.Func\`3')[ProgressBarEvent](ProgressBarEvent.md 'PromptPlusLibrary\.ProgressBarEvent')[,](https://learn.microsoft.com/en-us/dotnet/api/system.func-3 'System\.Func\`3')[System\.Threading\.CancellationToken](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken 'System\.Threading\.CancellationToken')[,](https://learn.microsoft.com/en-us/dotnet/api/system.func-3 'System\.Func\`3')[System\.Threading\.Tasks\.Task](https://learn.microsoft.com/en-us/dotnet/api/system.threading.tasks.task 'System\.Threading\.Tasks\.Task')[>](https://learn.microsoft.com/en-us/dotnet/api/system.func-3 'System\.Func\`3') Async callback that receives [ProgressBarEvent](ProgressBarEvent.md 'PromptPlusLibrary\.ProgressBarEvent') and [System\.Threading\.CancellationToken](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken 'System\.Threading\.CancellationToken')\. Cannot be `null`\. `context` [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 key/value context data passed to the callback\. #### Returns [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') The current [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown when [value](IProgressBarControl.md#PromptPlusLibrary.IProgressBarControl.UpdateHandlerAsync(System.Func_PromptPlusLibrary.ProgressBarEvent,System.Threading.CancellationToken,System.Threading.Tasks.Task_,System.Collections.Generic.IDictionary_string,object_).value 'PromptPlusLibrary\.IProgressBarControl\.UpdateHandlerAsync\(System\.Func\, System\.Collections\.Generic\.IDictionary\\)\.value') is `null`\. ## IProgressBarControl\.Width\(byte\) Method Sets the ProgressBar width\. Default is 40 and minimum is 10\. ```csharp PromptPlusLibrary.IProgressBarControl Width(byte value); ``` #### Parameters `value` [System\.Byte](https://learn.microsoft.com/en-us/dotnet/api/system.byte 'System\.Byte') The width of the ProgressBar\. #### Returns [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') The current [IProgressBarControl](IProgressBarControl.md 'PromptPlusLibrary\.IProgressBarControl') instance for chaining\. #### Exceptions [System\.ArgumentOutOfRangeException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentoutofrangeexception 'System\.ArgumentOutOfRangeException') Thrown when [value](IProgressBarControl.md#PromptPlusLibrary.IProgressBarControl.Width(byte).value 'PromptPlusLibrary\.IProgressBarControl\.Width\(byte\)\.value') is less than 10\.