#### [PromptPlus](PromptPlus.md 'PromptPlus') ### [PromptPlusLibrary](PromptPlusLibrary.md 'PromptPlusLibrary') ## IMaskEditNumberControl\ Interface Provides a fluent API for configuring and running a masked integer input control\. ```csharp public interface IMaskEditNumberControl ``` #### Type parameters `T` The integer type for the input value\. Supported types: [System\.Int32](https://learn.microsoft.com/en-us/dotnet/api/system.int32 'System\.Int32'), [System\.Int64](https://learn.microsoft.com/en-us/dotnet/api/system.int64 'System\.Int64')\. ### Remarks The number format \(digit count, sign, and thousands separator\) is defined by [NumberFormat\(byte, bool, bool\)](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.NumberFormat(byte,bool,bool) 'PromptPlusLibrary\.IMaskEditNumberControl\\.NumberFormat\(byte, bool, bool\)')\. The culture controls digit group and decimal separator characters\. Call [Run\(CancellationToken\)](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.Run(System.Threading.CancellationToken) 'PromptPlusLibrary\.IMaskEditNumberControl\\.Run\(System\.Threading\.CancellationToken\)') last to display the control and read the submitted integer value\. ### Methods ## IMaskEditNumberControl\\.Culture\(string\) Method Sets the culture for number formatting and validation using a culture name\. ```csharp PromptPlusLibrary.IMaskEditNumberControl Culture(string cultureName); ``` #### Parameters `cultureName` [System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String') The culture name to use for validation and number formatting\. Cannot be `null` or empty\. #### Returns [PromptPlusLibrary\.IMaskEditNumberControl<](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\')[T](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.T 'PromptPlusLibrary\.IMaskEditNumberControl\\.T')[>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') The current [IMaskEditNumberControl<T>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') instance for chaining\. #### Exceptions [System\.ArgumentException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentexception 'System\.ArgumentException') Thrown if [cultureName](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.Culture(string).cultureName 'PromptPlusLibrary\.IMaskEditNumberControl\\.Culture\(string\)\.cultureName') is `null` or empty\. ## IMaskEditNumberControl\\.Culture\(CultureInfo\) Method Sets the culture for number formatting and validation\. ```csharp PromptPlusLibrary.IMaskEditNumberControl 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 for validation and number formatting\. #### Returns [PromptPlusLibrary\.IMaskEditNumberControl<](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\')[T](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.T 'PromptPlusLibrary\.IMaskEditNumberControl\\.T')[>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') The current [IMaskEditNumberControl<T>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') instance for chaining\. ## IMaskEditNumberControl\\.Default\(T\) Method Sets the value pre\-filled when the control is first displayed\. ```csharp PromptPlusLibrary.IMaskEditNumberControl Default(T value); ``` #### Parameters `value` [T](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.T 'PromptPlusLibrary\.IMaskEditNumberControl\\.T') The initial value shown in the input field\. #### Returns [PromptPlusLibrary\.IMaskEditNumberControl<](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\')[T](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.T 'PromptPlusLibrary\.IMaskEditNumberControl\\.T')[>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') The current [IMaskEditNumberControl<T>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') instance for chaining\. ## IMaskEditNumberControl\\.DefaultIfEmpty\(T\) Method Sets the value returned when the user submits without typing any digits\. ```csharp PromptPlusLibrary.IMaskEditNumberControl DefaultIfEmpty(T value); ``` #### Parameters `value` [T](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.T 'PromptPlusLibrary\.IMaskEditNumberControl\\.T') The fallback value used when the input field is left empty\. #### Returns [PromptPlusLibrary\.IMaskEditNumberControl<](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\')[T](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.T 'PromptPlusLibrary\.IMaskEditNumberControl\\.T')[>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') The current [IMaskEditNumberControl<T>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') instance for chaining\. ## IMaskEditNumberControl\\.HideTipInputType\(bool\) Method Hides the input\-type hint shown below the numeric field\. Default is `false` \(hint visible\)\. ```csharp PromptPlusLibrary.IMaskEditNumberControl 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\.IMaskEditNumberControl<](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\')[T](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.T 'PromptPlusLibrary\.IMaskEditNumberControl\\.T')[>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') The current [IMaskEditNumberControl<T>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') instance for chaining\. ## IMaskEditNumberControl\\.NumberFormat\(byte, bool, bool\) Method Configures the number format for the input with specified formatting options\. ```csharp PromptPlusLibrary.IMaskEditNumberControl NumberFormat(byte integerpart, bool withsignal=false, bool withseparatorgroup=true); ``` #### Parameters `integerpart` [System\.Byte](https://learn.microsoft.com/en-us/dotnet/api/system.byte 'System\.Byte') The maximum number of digits allowed in the integer part\. `withsignal` [System\.Boolean](https://learn.microsoft.com/en-us/dotnet/api/system.boolean 'System\.Boolean') If `true`, allows a sign \(\+/\-\) in the input\. Default is `false`\. `withseparatorgroup` [System\.Boolean](https://learn.microsoft.com/en-us/dotnet/api/system.boolean 'System\.Boolean') If `true`, allows group separators \(e\.g\., thousands separator\)\. Default is `true`\. #### Returns [PromptPlusLibrary\.IMaskEditNumberControl<](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\')[T](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.T 'PromptPlusLibrary\.IMaskEditNumberControl\\.T')[>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') The current [IMaskEditNumberControl<T>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') instance for chaining\. ## IMaskEditNumberControl\\.Options\(Action\\) Method Applies shared control options \(such as prompt text, tooltip visibility, and abort behavior\)\. ```csharp PromptPlusLibrary.IMaskEditNumberControl 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 [PromptPlusLibrary\.IMaskEditNumberControl<](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\')[T](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.T 'PromptPlusLibrary\.IMaskEditNumberControl\\.T')[>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') The current [IMaskEditNumberControl<T>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown if [options](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.Options(System.Action_PromptPlusLibrary.IControlOptions_).options 'PromptPlusLibrary\.IMaskEditNumberControl\\.Options\(System\.Action\\)\.options') is `null`\. ## IMaskEditNumberControl\\.PredicateSelected\(Func\\) Method Sets a synchronous validation predicate executed when the user confirms the value\. ```csharp PromptPlusLibrary.IMaskEditNumberControl PredicateSelected(System.Func validselect); ``` #### Parameters `validselect` [System\.Func<](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2')[T](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.T 'PromptPlusLibrary\.IMaskEditNumberControl\\.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 submitted value is acceptable\. #### Returns [PromptPlusLibrary\.IMaskEditNumberControl<](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\')[T](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.T 'PromptPlusLibrary\.IMaskEditNumberControl\\.T')[>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') The current [IMaskEditNumberControl<T>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') instance for chaining\. ## IMaskEditNumberControl\\.PredicateSelectedAsync\(Func\\>\) Method Sets an asynchronous validation predicate that determines whether the selected item is valid\. ```csharp PromptPlusLibrary.IMaskEditNumberControl PredicateSelectedAsync(System.Func> validselect); ``` #### Parameters `validselect` [System\.Func<](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2')[T](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.T 'PromptPlusLibrary\.IMaskEditNumberControl\\.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\.IMaskEditNumberControl<](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\')[T](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.T 'PromptPlusLibrary\.IMaskEditNumberControl\\.T')[>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') The current [IMaskEditNumberControl<T>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') instance for chaining\. ### Remarks The asynchronous predicate is evaluated synchronously \(blocking\) on the UI thread; it does not run in parallel\. ## IMaskEditNumberControl\\.PromptMask\(char\) Method Sets the placeholder character shown in empty input positions\. Default is `'_'`\. ```csharp PromptPlusLibrary.IMaskEditNumberControl 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 positions\. #### Returns [PromptPlusLibrary\.IMaskEditNumberControl<](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\')[T](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.T 'PromptPlusLibrary\.IMaskEditNumberControl\\.T')[>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') The current [IMaskEditNumberControl<T>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') instance for chaining\. ## IMaskEditNumberControl\\.Run\(CancellationToken\) Method Displays the masked integer input control and blocks until the user confirms or cancels, returning the submitted integer 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](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.T 'PromptPlusLibrary\.IMaskEditNumberControl\\.T')[>](ResultPrompt_T_.md 'PromptPlusLibrary\.ResultPrompt\') A [ResultPrompt<T>](ResultPrompt_T_.md 'PromptPlusLibrary\.ResultPrompt\') containing the submitted integer value\. ## IMaskEditNumberControl\\.Styles\(MaskEditStyles, Style\) Method Overrides the visual style applied to a specific region of the integer input control\. ```csharp PromptPlusLibrary.IMaskEditNumberControl 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\.IMaskEditNumberControl<](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\')[T](IMaskEditNumberControl_T_.md#PromptPlusLibrary.IMaskEditNumberControl_T_.T 'PromptPlusLibrary\.IMaskEditNumberControl\\.T')[>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') The current [IMaskEditNumberControl<T>](IMaskEditNumberControl_T_.md 'PromptPlusLibrary\.IMaskEditNumberControl\') instance for chaining\.