DateTimeOffsetConverter

Artikel
03/19/2024

DateTimeOffsetConverter ist ein Konverter, mit dem Benutzer ein DateTimeOffset in DateTime konvertieren können. Manchmal wird ein DateTime-Wert mit dem Offset auf einem Back-End gespeichert, um die Zeitzone zu speichern, in der ein DateTime seinen Ursprung hat. Steuerelemente wie Microsoft.Maui.Controls.DatePicker funktionieren nur mit DateTime. Dieser Konverter kann in diesen Szenarien verwendet werden.

BaseConverter-Eigenschaften

Die folgenden Eigenschaften werden in der Basisklasse public abstract class BaseConverter implementiert:

Eigenschaft	Beschreibung
`DefaultConvertReturnValue`	Standardwert, der zurückgegeben werden soll, wenn `IValueConverter.Convert(object?, Type, object?, CultureInfo?)` eine `Exception` auslöst. Dieser Wert wird verwendet, wenn CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` auf `true` festgelegt ist.
`DefaultConvertBackReturnValue`	Standardwert, der zurückgegeben werden soll, wenn `IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?)` eine `Exception` auslöst. Dieser Wert wird verwendet, wenn CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` auf `true` festgelegt ist.

ICommunityToolkitValueConverter-Eigenschaften

Die folgenden Eigenschaften werden im public interface ICommunityToolkitValueConverter implementiert:

Eigenschaft	Typ	Beschreibung
`DefaultConvertReturnValue`	`object?`	Standardwert, der zurückgegeben werden soll, wenn `IValueConverter.Convert(object?, Type, object?, CultureInfo?)` eine `Exception` auslöst. Dieser Wert wird verwendet, wenn CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` auf `true` festgelegt ist.
`DefaultConvertBackReturnValue`	`object?`	Standardwert, der zurückgegeben werden soll, wenn `IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?)` eine `Exception` auslöst. Dieser Wert wird verwendet, wenn CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` auf `true` festgelegt ist.

Syntax

XAML

Einbinden des XAML-Namespace

Um das Toolkit in XAML verwenden zu können, muss der folgende xmlns-Abschnitt zu Ihrer Seite oder Ansicht hinzugefügt werden:

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

Der folgende Abschnitt:

<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>

Würde dann geändert werden, um xmlns einzubinden:

<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>

Verwenden von DateTimeOffsetConverter

DateTimeOffsetConverter kann wie folgt in XAML verwendet werden:

<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#

DateTimeOffsetConverter kann wie folgt in C# verwendet werden:

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;
    }
}

C#-Markup

Das Paket CommunityToolkit.Maui.Markup bietet eine viel präzisere Möglichkeit, diesen Konverter in C# zu verwenden.

using CommunityToolkit.Maui.Markup;

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

Beispiele

Ein Beispiel für diesen Konverter in Aktion finden Sie in der Beispielanwendung für das .NET MAUI Community Toolkit.

API

Sie finden den Quellcode für DateTimeOffsetConverter über das GitHub-Repository für das .NET MAUI Community Toolkit.

Freigeben über