#### [PromptPlus](PromptPlus.md 'PromptPlus') ### [PromptPlusLibrary](PromptPlusLibrary.md 'PromptPlusLibrary') ## IMaskEditStringControl\ Interface Provides a fluent API for configuring and running a masked string input control\. ```csharp public interface IMaskEditStringControl ``` #### Type parameters `T` The type for the input value\. Must be [System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String')\. ### Remarks The user can only type characters that are allowed by the mask pattern defined via [Mask\(string, bool\)](IMaskEditStringControl_T_.md#PromptPlusLibrary.IMaskEditStringControl_T_.Mask(string,bool) 'PromptPlusLibrary\.IMaskEditStringControl\\.Mask\(string, bool\)')\. Literal characters in the mask are displayed but cannot be edited\. Call [Run\(CancellationToken\)](IMaskEditStringControl_T_.md#PromptPlusLibrary.IMaskEditStringControl_T_.Run(System.Threading.CancellationToken) 'PromptPlusLibrary\.IMaskEditStringControl\\.Run\(System\.Threading\.CancellationToken\)') last to display the control and read the submitted value\. ### Methods ## IMaskEditStringControl\\.Default\(T\) Method Sets the default value for the input\. ```csharp PromptPlusLibrary.IMaskEditStringControl Default(T value); ``` #### Parameters `value` [T](IMaskEditStringControl_T_.md#PromptPlusLibrary.IMaskEditStringControl_T_.T 'PromptPlusLibrary\.IMaskEditStringControl\\.T') The default value\. #### Returns [PromptPlusLibrary\.IMaskEditStringControl<](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\')[T](IMaskEditStringControl_T_.md#PromptPlusLibrary.IMaskEditStringControl_T_.T 'PromptPlusLibrary\.IMaskEditStringControl\\.T')[>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') The current [IMaskEditStringControl<T>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') instance for chaining\. ## IMaskEditStringControl\\.DefaultIfEmpty\(T\) Method Sets the default value to use when the input is empty\. ```csharp PromptPlusLibrary.IMaskEditStringControl DefaultIfEmpty(T value); ``` #### Parameters `value` [T](IMaskEditStringControl_T_.md#PromptPlusLibrary.IMaskEditStringControl_T_.T 'PromptPlusLibrary\.IMaskEditStringControl\\.T') The default value for empty input\. #### Returns [PromptPlusLibrary\.IMaskEditStringControl<](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\')[T](IMaskEditStringControl_T_.md#PromptPlusLibrary.IMaskEditStringControl_T_.T 'PromptPlusLibrary\.IMaskEditStringControl\\.T')[>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') The current [IMaskEditStringControl<T>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') instance for chaining\. ## IMaskEditStringControl\\.HideTipInputType\(bool\) Method Hides the input\-type hint shown below the masked field\. Default is `false` \(hint visible\)\. ```csharp PromptPlusLibrary.IMaskEditStringControl HideTipInputType(bool value=true); ``` #### Parameters `value` [System\.Boolean](https://learn.microsoft.com/en-us/dotnet/api/system.boolean 'System\.Boolean') If `true`, the input\-type hint is hidden; otherwise, it is shown\. #### Returns [PromptPlusLibrary\.IMaskEditStringControl<](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\')[T](IMaskEditStringControl_T_.md#PromptPlusLibrary.IMaskEditStringControl_T_.T 'PromptPlusLibrary\.IMaskEditStringControl\\.T')[>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') The current [IMaskEditStringControl<T>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') instance for chaining\. ## IMaskEditStringControl\\.InputMode\(InputBehavior\) Method Sets how the cursor behaves when the user starts typing inside the masked field\. Default is [EditSkipToInput](InputBehavior.md#PromptPlusLibrary.InputBehavior.EditSkipToInput 'PromptPlusLibrary\.InputBehavior\.EditSkipToInput'), which moves the cursor to the first editable position automatically\. ```csharp PromptPlusLibrary.IMaskEditStringControl InputMode(PromptPlusLibrary.InputBehavior inputBehavior=PromptPlusLibrary.InputBehavior.EditSkipToInput); ``` #### Parameters `inputBehavior` [InputBehavior](InputBehavior.md 'PromptPlusLibrary\.InputBehavior') The input behavior to apply\. #### Returns [PromptPlusLibrary\.IMaskEditStringControl<](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\')[T](IMaskEditStringControl_T_.md#PromptPlusLibrary.IMaskEditStringControl_T_.T 'PromptPlusLibrary\.IMaskEditStringControl\\.T')[>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') The current [IMaskEditStringControl<T>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') instance for chaining\. ## IMaskEditStringControl\\.Mask\(string, bool\) Method Sets the input mask pattern, Required\!\. ```csharp PromptPlusLibrary.IMaskEditStringControl Mask(string mask, bool returnWithMask=false); ``` #### Parameters `mask` [System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String') The mask pattern\. Mask rules: - Any character not defined in the rules will be treated as a literal character - 9 - Numeric character accepts delimiters for constant or custom. - L - Lower Letter character accepts delimiters for constant or custom. - U - Upper Letter character accepts delimiters for constant or custom. - A - Lower and Upper Letter character accepts delimiters for constant or custom. - X - Numeric, Lower and Upper Letter character accepts delimiters for constant or custom. - C - Custom character accepts only delimiters for custom. - \ - Escape character to use the next char as constant. - { } - Delimiters group to apply custom list or constant value, valid only a single mask type inside the group. - [ ] - Delimiters for custom value. - ( ) - Delimiters for constant value inside the group. `returnWithMask` [System\.Boolean](https://learn.microsoft.com/en-us/dotnet/api/system.boolean 'System\.Boolean') If `true`, the result includes the mask\. Default value is `false`\. #### Returns [PromptPlusLibrary\.IMaskEditStringControl<](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\')[T](IMaskEditStringControl_T_.md#PromptPlusLibrary.IMaskEditStringControl_T_.T 'PromptPlusLibrary\.IMaskEditStringControl\\.T')[>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') The current [IMaskEditStringControl<T>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') instance for chaining\. ### Remarks The mask can include literal characters and special pattern characters to define the input format\. ## IMaskEditStringControl\\.Options\(Action\\) Method Applies custom options to the MaskEdit input control\. ```csharp PromptPlusLibrary.IMaskEditStringControl 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 [PromptPlusLibrary\.IMaskEditStringControl<](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\')[T](IMaskEditStringControl_T_.md#PromptPlusLibrary.IMaskEditStringControl_T_.T 'PromptPlusLibrary\.IMaskEditStringControl\\.T')[>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') The current [IMaskEditStringControl<T>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown if [options](IMaskEditStringControl_T_.md#PromptPlusLibrary.IMaskEditStringControl_T_.Options(System.Action_PromptPlusLibrary.IControlOptions_).options 'PromptPlusLibrary\.IMaskEditStringControl\\.Options\(System\.Action\\)\.options') is `null`\. ## IMaskEditStringControl\\.PredicateSelected\(Func\\) Method Sets a synchronous validation predicate that determines whether the submitted value is valid\. ```csharp PromptPlusLibrary.IMaskEditStringControl PredicateSelected(System.Func validselect); ``` #### Parameters `validselect` [System\.Func<](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2')[T](IMaskEditStringControl_T_.md#PromptPlusLibrary.IMaskEditStringControl_T_.T 'PromptPlusLibrary\.IMaskEditStringControl\\.T')[,](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 `true` when the value is valid\. #### Returns [PromptPlusLibrary\.IMaskEditStringControl<](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\')[T](IMaskEditStringControl_T_.md#PromptPlusLibrary.IMaskEditStringControl_T_.T 'PromptPlusLibrary\.IMaskEditStringControl\\.T')[>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') The current [IMaskEditStringControl<T>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') instance for chaining\. ## IMaskEditStringControl\\.PredicateSelectedAsync\(Func\\>\) Method Sets an asynchronous validation predicate that determines whether the selected item is valid\. ```csharp PromptPlusLibrary.IMaskEditStringControl PredicateSelectedAsync(System.Func> validselect); ``` #### Parameters `validselect` [System\.Func<](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2')[T](IMaskEditStringControl_T_.md#PromptPlusLibrary.IMaskEditStringControl_T_.T 'PromptPlusLibrary\.IMaskEditStringControl\\.T')[,](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 `true` when an item is valid and can be selected\. #### Returns [PromptPlusLibrary\.IMaskEditStringControl<](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\')[T](IMaskEditStringControl_T_.md#PromptPlusLibrary.IMaskEditStringControl_T_.T 'PromptPlusLibrary\.IMaskEditStringControl\\.T')[>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') The current [IMaskEditStringControl<T>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') instance for chaining\. ### Remarks The asynchronous predicate is evaluated synchronously \(blocking\) on the UI thread; it does not run in parallel\. ## IMaskEditStringControl\\.PromptMask\(char\) Method Sets the placeholder character shown in empty input positions of the mask\. Default is `'_'`\. ```csharp PromptPlusLibrary.IMaskEditStringControl PromptMask(char value='_'); ``` #### Parameters `value` [System\.Char](https://learn.microsoft.com/en-us/dotnet/api/system.char 'System\.Char') The placeholder character displayed in unfilled mask positions\. #### Returns [PromptPlusLibrary\.IMaskEditStringControl<](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\')[T](IMaskEditStringControl_T_.md#PromptPlusLibrary.IMaskEditStringControl_T_.T 'PromptPlusLibrary\.IMaskEditStringControl\\.T')[>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') The current [IMaskEditStringControl<T>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') instance for chaining\. ## IMaskEditStringControl\\.Run\(CancellationToken\) Method Displays the masked input control and blocks until the user confirms or cancels, returning the submitted \(and optionally unmasked\) 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 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\')[T](IMaskEditStringControl_T_.md#PromptPlusLibrary.IMaskEditStringControl_T_.T 'PromptPlusLibrary\.IMaskEditStringControl\\.T')[>](ResultPrompt_T_.md 'PromptPlusLibrary\.ResultPrompt\') A [ResultPrompt<T>](ResultPrompt_T_.md 'PromptPlusLibrary\.ResultPrompt\') containing the submitted string value\. ## IMaskEditStringControl\\.Styles\(MaskEditStyles, Style\) Method Overrides the visual style applied to a specific region of the masked input control\. ```csharp PromptPlusLibrary.IMaskEditStringControl Styles(PromptPlusLibrary.MaskEditStyles styleType, ConsolePlusLibrary.Style style); ``` #### Parameters `styleType` [MaskEditStyles](MaskEditStyles.md 'PromptPlusLibrary\.MaskEditStyles') The [MaskEditStyles](MaskEditStyles.md 'PromptPlusLibrary\.MaskEditStyles') 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 [PromptPlusLibrary\.IMaskEditStringControl<](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\')[T](IMaskEditStringControl_T_.md#PromptPlusLibrary.IMaskEditStringControl_T_.T 'PromptPlusLibrary\.IMaskEditStringControl\\.T')[>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') The current [IMaskEditStringControl<T>](IMaskEditStringControl_T_.md 'PromptPlusLibrary\.IMaskEditStringControl\') instance for chaining\.