#### [PromptPlus](PromptPlus.md 'PromptPlus') ### [PromptPlusLibrary](PromptPlusLibrary.md 'PromptPlusLibrary') ## IInputControl Interface Provides a fluent API for configuring and running an interactive text input control\. ```csharp public interface IInputControl ``` ### Remarks The user types free text that is shown in plain view \(for hidden/secret input use [IInputSecretControl](IInputSecretControl.md 'PromptPlusLibrary\.IInputSecretControl') instead\)\. Features include optional character filtering, case coercion, max\-length enforcement, Tab/Shift\+Tab autocomplete suggestions, F3 history navigation, and confirmation\-time validation\. Call [Run\(CancellationToken\)](IInputControl.md#PromptPlusLibrary.IInputControl.Run(System.Threading.CancellationToken) 'PromptPlusLibrary\.IInputControl\.Run\(System\.Threading\.CancellationToken\)') last to display the control and read the submitted value\. ### Methods ## IInputControl\.AcceptInput\(Func\\) Method Sets a filter that validates each typed character before it is added to the input\. ```csharp PromptPlusLibrary.IInputControl AcceptInput(System.Func value); ``` #### Parameters `value` [System\.Func<](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2')[System\.Char](https://learn.microsoft.com/en-us/dotnet/api/system.char 'System\.Char')[,](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2')[System\.Boolean](https://learn.microsoft.com/en-us/dotnet/api/system.boolean 'System\.Boolean')[>](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2') A function that receives a character and returns `true` to accept it, or `false` to ignore it\. #### Returns [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') The current [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown if [value](IInputControl.md#PromptPlusLibrary.IInputControl.AcceptInput(System.Func_char,bool_).value 'PromptPlusLibrary\.IInputControl\.AcceptInput\(System\.Func\\)\.value') is `null`\. ### Remarks If the callback returns `true`, the character is accepted; otherwise, it is ignored\. ## IInputControl\.ChangeDescription\(Func\\) Method Updates the control description dynamically using a synchronous callback\. ```csharp PromptPlusLibrary.IInputControl ChangeDescription(System.Func value); ``` #### Parameters `value` [System\.Func<](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')[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 description and returns the updated description\. Cannot be `null`\. #### Returns [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') The current [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown if [value](IInputControl.md#PromptPlusLibrary.IInputControl.ChangeDescription(System.Func_string,string_).value 'PromptPlusLibrary\.IInputControl\.ChangeDescription\(System\.Func\\)\.value') is `null`\. ## IInputControl\.ChangeDescriptionAsync\(Func\\>\) Method Updates the control description dynamically using an asynchronous callback\. ```csharp PromptPlusLibrary.IInputControl ChangeDescriptionAsync(System.Func> value); ``` #### Parameters `value` [System\.Func<](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')[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') A function that asynchronously receives the current description and returns the updated description\. Cannot be `null`\. #### Returns [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') The current [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown if [value](IInputControl.md#PromptPlusLibrary.IInputControl.ChangeDescriptionAsync(System.Func_string,System.Threading.Tasks.Task_string__).value 'PromptPlusLibrary\.IInputControl\.ChangeDescriptionAsync\(System\.Func\\>\)\.value') is `null`\. ## IInputControl\.Default\(string, bool\) Method Sets the initial text displayed before the user starts typing\. ```csharp PromptPlusLibrary.IInputControl Default(string value, bool useDefaultHistory=true); ``` #### Parameters `value` [System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String') The initial value to display\. Cannot be `null`\. `useDefaultHistory` [System\.Boolean](https://learn.microsoft.com/en-us/dotnet/api/system.boolean 'System\.Boolean') If `true` and history is enabled with [EnableHistory\(string, Action<IHistoryOptions>\)](IInputControl.md#PromptPlusLibrary.IInputControl.EnableHistory(string,System.Action_PromptPlusLibrary.IHistoryOptions_) 'PromptPlusLibrary\.IInputControl\.EnableHistory\(string, System\.Action\\)'), the most recent history value is preferred; otherwise, [value](IInputControl.md#PromptPlusLibrary.IInputControl.Default(string,bool).value 'PromptPlusLibrary\.IInputControl\.Default\(string, bool\)\.value') is used\. #### Returns [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') The current [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') instance for chaining\. ## IInputControl\.DefaultIfEmpty\(string\) Method Sets the fallback value returned when the user submits without typing any text\. ```csharp PromptPlusLibrary.IInputControl DefaultIfEmpty(string value); ``` #### Parameters `value` [System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String') The default value to use when the input is empty\. #### Returns [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') The current [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') instance for chaining\. ## IInputControl\.EnableHistory\(string, Action\\) Method Enables input history \(F3\) and optionally customizes how history is stored and loaded\. ```csharp PromptPlusLibrary.IInputControl EnableHistory(string filename, System.Action? options=null); ``` #### Parameters `filename` [System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String') The name of the file to store history\. Cannot be `null`\. `options` [System\.Action<](https://learn.microsoft.com/en-us/dotnet/api/system.action-1 'System\.Action\`1')[IHistoryOptions](IHistoryOptions.md 'PromptPlusLibrary\.IHistoryOptions')[>](https://learn.microsoft.com/en-us/dotnet/api/system.action-1 'System\.Action\`1') An action to configure [IHistoryOptions](IHistoryOptions.md 'PromptPlusLibrary\.IHistoryOptions')\. Optional\. #### Returns [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') The current [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown if [filename](IInputControl.md#PromptPlusLibrary.IInputControl.EnableHistory(string,System.Action_PromptPlusLibrary.IHistoryOptions_).filename 'PromptPlusLibrary\.IInputControl\.EnableHistory\(string, System\.Action\\)\.filename') is `null`\. ## IInputControl\.InputToCase\(CaseOptions\) Method Forces entered text to follow the specified casing rule\. Default is [ConsolePlusLibrary\.CaseOptions\.Any](https://learn.microsoft.com/en-us/dotnet/api/consolepluslibrary.caseoptions.any 'ConsolePlusLibrary\.CaseOptions\.Any') \(no transformation\)\. ```csharp PromptPlusLibrary.IInputControl InputToCase(ConsolePlusLibrary.CaseOptions value); ``` #### Parameters `value` [ConsolePlusLibrary\.CaseOptions](https://learn.microsoft.com/en-us/dotnet/api/consolepluslibrary.caseoptions 'ConsolePlusLibrary\.CaseOptions') The case transformation option to apply\. #### Returns [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') The current [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') instance for chaining\. ## IInputControl\.MaxLength\(int\) Method Limits the number of characters that can be entered\. Default is zero or less \(no limit\)\. ```csharp PromptPlusLibrary.IInputControl MaxLength(int maxLength); ``` #### Parameters `maxLength` [System\.Int32](https://learn.microsoft.com/en-us/dotnet/api/system.int32 'System\.Int32') The maximum number of characters allowed for the input\. #### Returns [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') The current [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') instance for chaining\. ## IInputControl\.MinimumSuggestionLength\(byte\) Method Sets the minimum number of characters that must be typed before the suggestion provider is invoked\. Default is `0` \(suggestions appear from the first character\)\. ```csharp PromptPlusLibrary.IInputControl MinimumSuggestionLength(byte value); ``` #### Parameters `value` [System\.Byte](https://learn.microsoft.com/en-us/dotnet/api/system.byte 'System\.Byte') The minimum number of characters\. Must be greater than or equal to 0\. #### Returns [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') The current [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') instance for chaining\. ## IInputControl\.Options\(Action\\) Method Applies additional control options using a synchronous configuration callback\. ```csharp PromptPlusLibrary.IInputControl 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') An action to configure the [IControlOptions](IControlOptions.md 'PromptPlusLibrary\.IControlOptions')\. Cannot be `null`\. #### Returns [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') The current [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown if [options](IInputControl.md#PromptPlusLibrary.IInputControl.Options(System.Action_PromptPlusLibrary.IControlOptions_).options 'PromptPlusLibrary\.IInputControl\.Options\(System\.Action\\)\.options') is `null`\. ## IInputControl\.PredicateValid\(Func\\) Method Sets a validation function executed when the user confirms the input\. ```csharp PromptPlusLibrary.IInputControl PredicateValid(System.Func validselect); ``` #### Parameters `validselect` [System\.Func<](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')[System\.Boolean](https://learn.microsoft.com/en-us/dotnet/api/system.boolean 'System\.Boolean')[>](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2') A predicate that returns whether the submitted value is valid\. #### Returns [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') The current [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') instance for chaining\. ## IInputControl\.PredicateValidAsync\(Func\\>\) Method Sets an asynchronous validation function executed when the user confirms the input\. ```csharp PromptPlusLibrary.IInputControl PredicateValidAsync(System.Func> validselect); ``` #### Parameters `validselect` [System\.Func<](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')[System\.Threading\.Tasks\.Task<](https://learn.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1 'System\.Threading\.Tasks\.Task\`1')[System\.Boolean](https://learn.microsoft.com/en-us/dotnet/api/system.boolean 'System\.Boolean')[>](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 asynchronous predicate that returns whether the submitted value is valid\. #### Returns [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') The current [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') instance for chaining\. ### Remarks The asynchronous predicate is evaluated synchronously \(blocking\) on the UI thread; it does not run in parallel\. ## IInputControl\.Run\(CancellationToken\) Method Displays the input control and blocks until the user submits or cancels, returning the final value\. ```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 control while it is waiting for input\. 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\')[System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String')[>](ResultPrompt_T_.md 'PromptPlusLibrary\.ResultPrompt\') A [ResultPrompt<T>](ResultPrompt_T_.md 'PromptPlusLibrary\.ResultPrompt\') containing the submitted [System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String') value, or an aborted result if the user cancelled\. ## IInputControl\.Styles\(InputStyles, Style\) Method Overrides one visual style used by the input control\. ```csharp PromptPlusLibrary.IInputControl Styles(PromptPlusLibrary.InputStyles styleType, ConsolePlusLibrary.Style style); ``` #### Parameters `styleType` [InputStyles](InputStyles.md 'PromptPlusLibrary\.InputStyles') The [InputStyles](InputStyles.md 'PromptPlusLibrary\.InputStyles') to override\. `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 [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') The current [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') instance for chaining\. ## IInputControl\.SuggestionHandler\(Func\, bool\) Method Adds a synchronous suggestion provider for Tab and Shift\+Tab completion\. ```csharp PromptPlusLibrary.IInputControl SuggestionHandler(System.Func value, bool autocomplete=true); ``` #### Parameters `value` [System\.Func<](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')[System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String')[\[\]](https://learn.microsoft.com/en-us/dotnet/api/system.array 'System\.Array')[>](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2') A function that receives the current input and returns an array of suggestions\. Cannot be `null`\. `autocomplete` [System\.Boolean](https://learn.microsoft.com/en-us/dotnet/api/system.boolean 'System\.Boolean') If `true` \(default\), pressing Tab/Shift\+Tab automatically applies the suggestion when only one match exists; if `false`, suggestions are shown in a list for manual selection\. #### Returns [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') The current [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown if [value](IInputControl.md#PromptPlusLibrary.IInputControl.SuggestionHandler(System.Func_string,string[]_,bool).value 'PromptPlusLibrary\.IInputControl\.SuggestionHandler\(System\.Func\, bool\)\.value') is `null`\. ## IInputControl\.SuggestionHandlerAsync\(Func\\>, bool\) Method Adds an asynchronous suggestion provider for Tab and Shift\+Tab completion\. ```csharp PromptPlusLibrary.IInputControl SuggestionHandlerAsync(System.Func> value, bool autocomplete=true); ``` #### Parameters `value` [System\.Func<](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')[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.array 'System\.Array')[>](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') A function that asynchronously receives the current input and returns an array of suggestions\. Cannot be `null`\. `autocomplete` [System\.Boolean](https://learn.microsoft.com/en-us/dotnet/api/system.boolean 'System\.Boolean') If `true` \(default\), pressing Tab/Shift\+Tab automatically applies the suggestion when only one match exists; if `false`, suggestions are shown in a list for manual selection\. #### Returns [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') The current [IInputControl](IInputControl.md 'PromptPlusLibrary\.IInputControl') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown if [value](IInputControl.md#PromptPlusLibrary.IInputControl.SuggestionHandlerAsync(System.Func_string,System.Threading.Tasks.Task_string[]__,bool).value 'PromptPlusLibrary\.IInputControl\.SuggestionHandlerAsync\(System\.Func\\>, bool\)\.value') is `null`\.