Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 2.55 KB

timepicker-selection.md

File metadata and controls

53 lines (41 loc) · 2.55 KB
Raw
title description ms.date
TimePicker item selection on iOS
This article explains how to consume the .NET MAUI iOS platform-specific that controls when item selection occurs in a TimePicker.
04/05/2022

TimePicker item selection on iOS

This .NET Multi-platform App UI (.NET MAUI) iOS platform-specific controls when item selection occurs in a xref:Microsoft.Maui.Controls.TimePicker, allowing the user to specify that item selection occurs when browsing items in the control, or only once the Done button is pressed. It's consumed in XAML by setting the TimePicker.UpdateMode attached property to a value of the UpdateMode enumeration:

<ContentPage ...
             xmlns:ios="clr-namespace:Microsoft.Maui.Controls.PlatformConfiguration.iOSSpecific;assembly=Microsoft.Maui.Controls">
    <StackLayout>
       <TimePicker Time="14:00:00"
                   ios:TimePicker.UpdateMode="WhenFinished" />
       ...
    </StackLayout>
</ContentPage>

Alternatively, it can be consumed from C# using the fluent API:

using Microsoft.Maui.Controls.PlatformConfiguration;
using Microsoft.Maui.Controls.PlatformConfiguration.iOSSpecific;
...

timePicker.On<iOS>().SetUpdateMode(UpdateMode.WhenFinished);

The TimePicker.On<iOS> method specifies that this platform-specific will only run on iOS. The TimePicker.SetUpdateMode method, in the Microsoft.Maui.Controls.PlatformConfiguration.iOSSpecific namespace, is used to control when item selection occurs, with the UpdateMode enumeration providing two possible values:

  • Immediately – item selection occurs as the user browses items in the xref:Microsoft.Maui.Controls.TimePicker. This is the default behavior.
  • WhenFinished – item selection only occurs once the user has pressed the Done button in the xref:Microsoft.Maui.Controls.TimePicker.

In addition, the SetUpdateMode method can be used to toggle the enumeration values by calling the UpdateMode method, which returns the current UpdateMode:

switch (timePicker.On<iOS>().UpdateMode())
{
    case UpdateMode.Immediately:
        timePicker.On<iOS>().SetUpdateMode(UpdateMode.WhenFinished);
        break;
    case UpdateMode.WhenFinished:
        timePicker.On<iOS>().SetUpdateMode(UpdateMode.Immediately);
        break;
}

The result is that a specified UpdateMode is applied to the xref:Microsoft.Maui.Controls.TimePicker, which controls when item selection occurs:

:::image type="content" source="media/timepicker-selection/timepicker-updatemode.png" alt-text="Screenshot of TimePicker update modes.":::