#### [PromptPlus](PromptPlus.md 'PromptPlus') ### [PromptPlusLibrary](PromptPlusLibrary.md 'PromptPlusLibrary') ## IMaskEditDateTimeControl\ Interface Provides a fluent API for configuring and running a masked date/time input control\. ```csharp public interface IMaskEditDateTimeControl ``` #### Type parameters `T` The date/time type\. Supported types: [System\.DateTime](https://learn.microsoft.com/en-us/dotnet/api/system.datetime 'System\.DateTime'), [System\.DateOnly](https://learn.microsoft.com/en-us/dotnet/api/system.dateonly 'System\.DateOnly'), [System\.TimeOnly](https://learn.microsoft.com/en-us/dotnet/api/system.timeonly 'System\.TimeOnly')\. ### Remarks Each segment of the date/time value \(day, month, year, hour, minute, etc\.\) is displayed as a separate editable field\. The user navigates between fields with the arrow keys and types digits to fill them in\. Individual fields can be locked to a constant value via [FixedValues\(DateTimePart, int\)](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.FixedValues(PromptPlusLibrary.DateTimePart,int) 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.FixedValues\(PromptPlusLibrary\.DateTimePart, int\)')\. Call [Run\(CancellationToken\)](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.Run(System.Threading.CancellationToken) 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.Run\(System\.Threading\.CancellationToken\)') last to display the control and read the submitted value\. ### Methods ## IMaskEditDateTimeControl\\.Culture\(string\) Method Sets the culture for date/time formatting and validation using a culture name\. ```csharp PromptPlusLibrary.IMaskEditDateTimeControl Culture(string cultureName); ``` #### Parameters `cultureName` [System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String') The name of the culture to use\. #### Returns [PromptPlusLibrary\.IMaskEditDateTimeControl<](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\')[T](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.T 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.T')[>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') The current [IMaskEditDateTimeControl<T>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') instance for chaining\. #### Exceptions [System\.ArgumentException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentexception 'System\.ArgumentException') Thrown when [cultureName](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.Culture(string).cultureName 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.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 is not found\. ## IMaskEditDateTimeControl\\.Culture\(CultureInfo\) Method Sets the culture for date/time formatting and validation using a CultureInfo object\. ```csharp PromptPlusLibrary.IMaskEditDateTimeControl 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 culture to use for validation and formatting\. #### Returns [PromptPlusLibrary\.IMaskEditDateTimeControl<](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\')[T](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.T 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.T')[>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') The current [IMaskEditDateTimeControl<T>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown when [culture](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.Culture(System.Globalization.CultureInfo).culture 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.Culture\(System\.Globalization\.CultureInfo\)\.culture') is `null`\. ## IMaskEditDateTimeControl\\.Default\(T\) Method Sets the initial default value for the input control\. ```csharp PromptPlusLibrary.IMaskEditDateTimeControl Default(T value); ``` #### Parameters `value` [T](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.T 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.T') The default value to use\. #### Returns [PromptPlusLibrary\.IMaskEditDateTimeControl<](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\')[T](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.T 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.T')[>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') The current [IMaskEditDateTimeControl<T>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') instance for chaining\. ## IMaskEditDateTimeControl\\.DefaultIfEmpty\(T\) Method Sets the fallback value to use when the input is empty\. ```csharp PromptPlusLibrary.IMaskEditDateTimeControl DefaultIfEmpty(T value); ``` #### Parameters `value` [T](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.T 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.T') The value to use when input is empty\. #### Returns [PromptPlusLibrary\.IMaskEditDateTimeControl<](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\')[T](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.T 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.T')[>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') The current [IMaskEditDateTimeControl<T>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') instance for chaining\. ## IMaskEditDateTimeControl\\.FixedValues\(DateTimePart, int\) Method Sets a fixed value for a specific date/time part that cannot be modified during input\. ```csharp PromptPlusLibrary.IMaskEditDateTimeControl FixedValues(PromptPlusLibrary.DateTimePart dateTimePart, int value); ``` #### Parameters `dateTimePart` [DateTimePart](DateTimePart.md 'PromptPlusLibrary\.DateTimePart') The datetime part to fix\. `value` [System\.Int32](https://learn.microsoft.com/en-us/dotnet/api/system.int32 'System\.Int32') The value to set\. Use \-1 to set to the current value of the part\. #### Returns [PromptPlusLibrary\.IMaskEditDateTimeControl<](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\')[T](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.T 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.T')[>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') The current [IMaskEditDateTimeControl<T>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') instance for chaining\. ## IMaskEditDateTimeControl\\.HideTipInputType\(bool\) Method Controls the visibility of the input type tip\. ```csharp PromptPlusLibrary.IMaskEditDateTimeControl HideTipInputType(bool value=true); ``` #### Parameters `value` [System\.Boolean](https://learn.microsoft.com/en-us/dotnet/api/system.boolean 'System\.Boolean') When `true`, hides the input type tip\. Default is `false`\. #### Returns [PromptPlusLibrary\.IMaskEditDateTimeControl<](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\')[T](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.T 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.T')[>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') The current [IMaskEditDateTimeControl<T>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') instance for chaining\. ## IMaskEditDateTimeControl\\.InputMode\(InputBehavior\) Method Sets the input behavior mode for the control\. ```csharp PromptPlusLibrary.IMaskEditDateTimeControl InputMode(PromptPlusLibrary.InputBehavior inputBehavior=PromptPlusLibrary.InputBehavior.EditSkipToInput); ``` #### Parameters `inputBehavior` [InputBehavior](InputBehavior.md 'PromptPlusLibrary\.InputBehavior') The input behavior to use\. Default is [EditSkipToInput](InputBehavior.md#PromptPlusLibrary.InputBehavior.EditSkipToInput 'PromptPlusLibrary\.InputBehavior\.EditSkipToInput')\. #### Returns [PromptPlusLibrary\.IMaskEditDateTimeControl<](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\')[T](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.T 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.T')[>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') The current [IMaskEditDateTimeControl<T>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') instance for chaining\. ## IMaskEditDateTimeControl\\.Options\(Action\\) Method Applies shared control options \(such as prompt text, tooltip visibility, and abort behavior\)\. ```csharp PromptPlusLibrary.IMaskEditDateTimeControl 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\.IMaskEditDateTimeControl<](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\')[T](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.T 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.T')[>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') The current [IMaskEditDateTimeControl<T>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown when [options](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.Options(System.Action_PromptPlusLibrary.IControlOptions_).options 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.Options\(System\.Action\\)\.options') is `null`\. ## IMaskEditDateTimeControl\\.PredicateSelected\(Func\\) Method Sets a synchronous validation predicate executed when the user confirms the value\. Returns `false` to reject the input and show a generic error\. ```csharp PromptPlusLibrary.IMaskEditDateTimeControl PredicateSelected(System.Func validselect); ``` #### Parameters `validselect` [System\.Func<](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2')[T](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.T 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.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\.IMaskEditDateTimeControl<](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\')[T](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.T 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.T')[>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') The current [IMaskEditDateTimeControl<T>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') instance for chaining\. #### Exceptions [System\.ArgumentNullException](https://learn.microsoft.com/en-us/dotnet/api/system.argumentnullexception 'System\.ArgumentNullException') Thrown when [validselect](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.PredicateSelected(System.Func_T,bool_).validselect 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.PredicateSelected\(System\.Func\\)\.validselect') is `null`\. ## IMaskEditDateTimeControl\\.PredicateSelectedAsync\(Func\\>\) Method Sets an asynchronous validation predicate that determines whether the selected item is valid\. ```csharp PromptPlusLibrary.IMaskEditDateTimeControl PredicateSelectedAsync(System.Func> validselect); ``` #### Parameters `validselect` [System\.Func<](https://learn.microsoft.com/en-us/dotnet/api/system.func-2 'System\.Func\`2')[T](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.T 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.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\.IMaskEditDateTimeControl<](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\')[T](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.T 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.T')[>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') The current [IMaskEditDateTimeControl<T>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') instance for chaining\. ### Remarks The asynchronous predicate is evaluated synchronously \(blocking\) on the UI thread; it does not run in parallel\. ## IMaskEditDateTimeControl\\.PromptMask\(char\) Method Sets the prompt mask character for unfilled positions in the input\. ```csharp PromptPlusLibrary.IMaskEditDateTimeControl PromptMask(char value='_'); ``` #### Parameters `value` [System\.Char](https://learn.microsoft.com/en-us/dotnet/api/system.char 'System\.Char') The character to use as the prompt mask\. Default is '\_'\. #### Returns [PromptPlusLibrary\.IMaskEditDateTimeControl<](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\')[T](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.T 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.T')[>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') The current [IMaskEditDateTimeControl<T>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') instance for chaining\. ## IMaskEditDateTimeControl\\.Run\(CancellationToken\) Method Displays the masked date/time input control and blocks until the user confirms or cancels, returning the submitted date/time 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](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.T 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.T')[>](ResultPrompt_T_.md 'PromptPlusLibrary\.ResultPrompt\') A [ResultPrompt<T>](ResultPrompt_T_.md 'PromptPlusLibrary\.ResultPrompt\') containing the submitted date/time value\. ## IMaskEditDateTimeControl\\.Styles\(MaskEditStyles, Style\) Method Overrides the visual style applied to a specific region of the date/time input control\. ```csharp PromptPlusLibrary.IMaskEditDateTimeControl 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\.IMaskEditDateTimeControl<](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\')[T](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.T 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.T')[>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') The current [IMaskEditDateTimeControl<T>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') instance for chaining\. ## IMaskEditDateTimeControl\\.WeekTypeMode\(WeekType\) Method Configures the display of week information for dates\. ```csharp PromptPlusLibrary.IMaskEditDateTimeControl WeekTypeMode(PromptPlusLibrary.WeekType value=PromptPlusLibrary.WeekType.WeekShort); ``` #### Parameters `value` [WeekType](WeekType.md 'PromptPlusLibrary\.WeekType') The week format to display\. Default is [WeekShort](WeekType.md#PromptPlusLibrary.WeekType.WeekShort 'PromptPlusLibrary\.WeekType\.WeekShort')\. #### Returns [PromptPlusLibrary\.IMaskEditDateTimeControl<](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\')[T](IMaskEditDateTimeControl_T_.md#PromptPlusLibrary.IMaskEditDateTimeControl_T_.T 'PromptPlusLibrary\.IMaskEditDateTimeControl\\.T')[>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') The current [IMaskEditDateTimeControl<T>](IMaskEditDateTimeControl_T_.md 'PromptPlusLibrary\.IMaskEditDateTimeControl\') instance for chaining\.