DateTimeOffsetConverter

Article
03/17/2024

Il s'agit DateTimeOffsetConverter d'un convertisseur qui permet aux utilisateurs de convertir un fichier DateTimeOffset dans un fichier DateTime. Parfois, une valeur DateTime est stockée avec le décalage sur un backend pour permettre de stocker le fuseau horaire d'où provient une valeur DateTime. Les contrôles comme le Microsoft.Maui.Controls.DatePicker seulement fonctionnent avec DateTime. Ce convertisseur peut être utilisé dans ces scénarios.

Propriétés BaseConverter

Les propriétés suivantes sont implémentées dans la classe de base, public abstract class BaseConverter :

Propriété	Description
`DefaultConvertReturnValue`	Valeur par défaut à renvoyer lorsque `IValueConverter.Convert(object?, Type, object?, CultureInfo?)` du lancement d'un `Exception`. Cette valeur est utilisée lorsque CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` est définie sur `true`.
`DefaultConvertBackReturnValue`	Valeur par défaut à retourner lorsque `IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?)` lève une `Exception`. Cette valeur est utilisée lorsque CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` est définie sur `true`.

Propriétés ICommunityToolkitValueConverter

Les propriétés suivantes sont implémentées dans le public interface ICommunityToolkitValueConverter:

Propriété	Type	Description
`DefaultConvertReturnValue`	`object?`	Valeur par défaut à renvoyer lorsque `IValueConverter.Convert(object?, Type, object?, CultureInfo?)` du lancement d'un `Exception`. Cette valeur est utilisée lorsque CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` est définie sur `true`.
`DefaultConvertBackReturnValue`	`object?`	Valeur par défaut à retourner lorsque `IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?)` lève une `Exception`. Cette valeur est utilisée lorsque CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` est définie sur `true`.

Syntaxe

XAML

Y compris l’espace de noms XAML

Pour utiliser le kit de ressources dans XAML, le xmlns suivant doit être ajouté à votre page ou à votre affichage :

xmlns:toolkit="http://schemas.microsoft.com/dotnet/2022/maui/toolkit"

Il en résulte ce qui suit :

<ContentPage
    x:Class="CommunityToolkit.Maui.Sample.Pages.MyPage"
    xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
    xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml">

</ContentPage>

Serait modifié pour inclure le xmlns de la manière suivante :

<ContentPage
    x:Class="CommunityToolkit.Maui.Sample.Pages.MyPage"
    xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
    xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
    xmlns:toolkit="http://schemas.microsoft.com/dotnet/2022/maui/toolkit">

</ContentPage>

Utilisation du DateTimeOffsetConverter

Le DateTimeOffsetConverter peut être utilisé de la manière suivante dans XAML :

<ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             xmlns:toolkit="http://schemas.microsoft.com/dotnet/2022/maui/toolkit"
             x:Class="MyLittleApp.MainPage">
    <ContentPage.Resources>
         <ResourceDictionary>
             <toolkit:DateTimeOffsetConverter x:Key="DateTimeOffsetConverter" />
         </ResourceDictionary>
    </ContentPage.Resources>

    <VerticalStackLayout>
            <Label Text="The DatePicker below is bound to a Property of type DateTimeOffset."
                   Margin="16"
                   HorizontalOptions="Center"
                   FontAttributes="Bold" />

            <DatePicker Date="{Binding TheDate, Converter={StaticResource DateTimeOffsetConverter}}" 
                   Margin="16"
                   HorizontalOptions="Center" />

            <Label Text="{Binding TheDate}"
                   Margin="16"
                   HorizontalOptions="Center"
                   FontAttributes="Bold" />
        </VerticalStackLayout>
</ContentPage>

C#

Le DateTimeOffsetConverter peut être utilisé de la manière suivante dans C# :

class DateTimeOffsetConverterPage : ContentPage
{
    public DateTimeOffsetConverterPage()
    {
        var label = new Label();

        label.SetBinding(
            Label.TextProperty,
            new Binding(
                static (ViewModels vm) => vm.MyValue,
                converter: new DateTimeOffsetConverter()));

        Content = label;
    }
}

Balisage C#

Notre package CommunityToolkit.Maui.Markup fournit une manière beaucoup plus concise d’utiliser ce convertisseur en C#.

using CommunityToolkit.Maui.Markup;

class DateTimeOffsetConverterPage : ContentPage
{
    public DateTimeOffsetConverterPage()
    {
        Content = new Label()
            .Bind(
                Label.TextProperty,
                static (ViewModel vm) => vm.MyValue,
                converter: new DateTimeOffsetConverter());
    }
}

Exemples

Vous pouvez trouver un exemple de ce convertisseur en action dans l'exemple d'application de la boîte à outils de la communauté .NET MAUI.

API

Vous pouvez trouver le code source deDateTimeOffsetConverter sur le référentiel du kit de ressources de la communauté .NET MAUI sur GitHub.

Partager via