IValueConverter Schnittstelle

Referenz

Definition

Namespace:: Microsoft.UI.Xaml.Data

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Bearbeiten

Macht Methoden verfügbar, mit denen die Daten geändert werden können, während sie die Bindungs-Engine durchlaufen.

public interface class IValueConverter

/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.WinUIContract, 65536)]
/// [Windows.Foundation.Metadata.Guid(2950507519, 4341, 20851, 183, 192, 53, 144, 189, 150, 203, 53)]
struct IValueConverter

[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.Guid(2950507519, 4341, 20851, 183, 192, 53, 144, 189, 150, 203, 53)]
public interface IValueConverter

Public Interface IValueConverter

Abgeleitet: Microsoft.UI.Xaml.Controls.Primitives.CornerRadiusFilterConverter

Microsoft.UI.Xaml.Controls.Primitives.CornerRadiusToThicknessConverter

Microsoft.UI.Xaml.Controls.Primitives.JumpListItemBackgroundConverter

Microsoft.UI.Xaml.Controls.Primitives.JumpListItemForegroundConverter

Attribute: ContractVersionAttribute GuidAttribute

Beispiele

Das folgende Beispiel zeigt, wie Sie die IValueConverter-Schnittstelle implementieren und den Konverter bei der Datenbindung an eine Auflistung von -Objekten verwenden.

Hinweis

Wenn Sie C++/WinRT (oder C++/CX) verwenden, finden Sie weitere Codebeispiele zum Erstellen eines eigenen Wertkonverters unter Formatieren oder Konvertieren von Datenwerten für die Anzeige . In diesem Thema wird auch erläutert, wie Sie das ConverterParameter-Attribut mit C++-Zeichenfolgenformatierungsfunktionen verwenden können.

<UserControl x:Class="ConverterParameterEx.Page"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" 
    xmlns:local="using:ConverterParameterEx" 
    Width="400" Height="300">
    <Grid x:Name="LayoutRoot" >
        <Grid.Resources>
           <local:DateFormatter x:Key="FormatConverter" />
        </Grid.Resources>
        
        <ComboBox Height="60" Width="250" x:Name="MusicCombo" 
            ItemsSource="{Binding}">
            <ComboBox.ItemTemplate>
                <DataTemplate>
                    <StackPanel>
                        <TextBlock FontWeight="Bold" Text="{Binding Path=Name, Mode=OneWay}" />
                        <TextBlock Text="{Binding Path=Artist, Mode=OneWay}" />
                        <TextBlock Text="{Binding Path=ReleaseDate, Mode=OneWay,
                            Converter={StaticResource FormatConverter}, 
                            ConverterParameter=\{0:d\}}" />
                   </StackPanel>
                </DataTemplate>
            </ComboBox.ItemTemplate>
        </ComboBox>
    </Grid>
</UserControl>

//
// MainPage.xaml.h
// Declaration of the MainPage class.
// 

#pragma once

#include "MainPage.g.h"

namespace IValueConverterExample
{

    // Simple business object.
    [Windows::UI::Xaml::Data::Bindable]
    public ref class Recording sealed 
    {
    public: 
        Recording (Platform::String^ artistName, Platform::String^ cdName, Windows::Foundation::DateTime release)
        {
            Artist = artistName;
            Name = cdName;
            ReleaseDate = release;
        }
        property Platform::String^ Artist;
        property Platform::String^ Name;
        property Windows::Foundation::DateTime ReleaseDate;
    };

    public ref class DateFormatter  sealed : Windows::UI::Xaml::Data::IValueConverter 
    {
        // This converts the DateTime object to the Platform::String^ to display.
    public:
        virtual Platform::Object^ Convert(Platform::Object^ value, Windows::UI::Xaml::Interop::TypeName targetType, 
            Platform::Object^ parameter, Platform::String^ language)
        {
            Windows::Foundation::DateTime dt = safe_cast<Windows::Foundation::DateTime>(value); 
            Windows::Globalization::DateTimeFormatting::DateTimeFormatter^ dtf =
                Windows::Globalization::DateTimeFormatting::DateTimeFormatter::ShortDate;
            return dtf->Format(dt); 
        }

        // No need to implement converting back on a one-way binding 
        virtual Platform::Object^ ConvertBack(Platform::Object^ value, Windows::UI::Xaml::Interop::TypeName targetType, 
            Platform::Object^ parameter, Platform::String^ language)
        {
            throw ref new Platform::NotImplementedException();
        }
    };

    /// <summary>
    /// An empty page that can be used on its own or navigated to within a Frame.
    /// </summary>
    public ref class MainPage sealed
    {
    public:
        MainPage()
        {	
            m_myMusic = ref new Platform::Collections::Vector<Recording^>();

            // Add items to the collection.

            // You can use a Calendar object to create a Windows::Foundation::DateTime
            auto c = ref new Windows::Globalization::Calendar();
            c->Year = 2008;
            c->Month = 2;
            c->Day = 5;
            m_myMusic->Append(ref new Recording("Chris Sells", "Chris Sells Live",
                c->GetDateTime()));

            c->Year = 2007;
            c->Month = 4;
            c->Day = 3;
            m_myMusic->Append(ref new Recording("Luka Abrus",
                "The Road to Redmond", c->GetDateTime()));
            
            c->Year = 2007;
            c->Month = 2;
            c->Day = 3;
            m_myMusic->Append(ref new Recording("Jim Hance",
                "The Best of Jim Hance", dt));
            InitializeComponent();

            // Set the data context for the combo box.
            MusicCombo->DataContext = m_myMusic;	
        }


    protected:
        virtual void OnNavigatedTo(Windows::UI::Xaml::Navigation::NavigationEventArgs^ e) override;

    private:
        Windows::Foundation::Collections::IVector<Recording^>^ m_myMusic;
    };
}

using System;
using System.Collections.ObjectModel;
using System.Globalization;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Data;

namespace ConverterParameterEx
{
    public partial class Page : UserControl
    {

        public ObservableCollection<Recording> MyMusic =
            new ObservableCollection<Recording>();
        public Page()
        {
            InitializeComponent();

            // Add items to the collection.
            MyMusic.Add(new Recording("Chris Sells", "Chris Sells Live",
                new DateTime(2008, 2, 5)));
            MyMusic.Add(new Recording("Luka Abrus",
                "The Road to Redmond", new DateTime(2007, 4, 3)));
            MyMusic.Add(new Recording("Jim Hance",
                "The Best of Jim Hance", new DateTime(2007, 2, 6)));

            // Set the data context for the combo box.
            MusicCombo.DataContext = MyMusic;
        }
    }

    // Simple business object.
    public class Recording
    {
        public Recording() { }
        public Recording(string artistName, string cdName, DateTime release)
        {
            Artist = artistName;
            Name = cdName;
            ReleaseDate = release;
        }
        public string Artist { get; set; }
        public string Name { get; set; }
        public DateTime ReleaseDate { get; set; }
    }

    public class DateFormatter : IValueConverter
    {
        // This converts the DateTime object to the string to display.
        public object Convert(object value, Type targetType, 
            object parameter, string language)
        {
            // Retrieve the format string and use it to format the value.
            string formatString = parameter as string;
            if (!string.IsNullOrEmpty(formatString))
            {
                return string.Format(
                    new CultureInfo(language), formatString, value);
            }
            // If the format string is null or empty, simply call ToString()
            // on the value.
            return value.ToString();
        }

        // No need to implement converting back on a one-way binding 
        public object ConvertBack(object value, Type targetType, 
            object parameter, string language)
        {
            throw new NotImplementedException();
        }
    }
}

Hinweise

Sie können eine Klasse erstellen, mit der Sie das Format Ihrer Daten zwischen der Quelle und dem Ziel konvertieren können, indem Sie von IValueConverter erben. Beispielsweise können Sie eine Liste von Farben haben, die Sie als RGBA-Werte speichern, aber diese mit Farbnamen auf der Benutzeroberfläche anzeigen. Durch die Implementierung von Convert und ConvertBack können Sie das Format der Datenwerte ändern, wenn sie von der Bindungs-Engine zwischen Ziel und Quelle übergeben werden. Sie sollten Convert immer mit einer funktionalen Implementierung implementieren, aber es ist ziemlich üblich, ConvertBack zu implementieren, damit eine nicht implementierte Ausnahme gemeldet wird. Sie benötigen nur eine ConvertBack-Methode in Ihrem Konverter, wenn Sie den Konverter für bidirektionale Bindungen oder XAML für die Serialisierung verwenden.

UnsetValue sollte von einer IValueConverter-Implementierung zurückgegeben werden, die eine Konvertierung in einer Datenbindung in eine Abhängigkeitseigenschaft bereitstellt, in jedem Fall, wenn der Konverter keinen Quellwert konvertieren kann. Konverter sollten für diesen Fall in Convert keine Ausnahmen auslösen. Diese werden als Laufzeitausnahmen angezeigt, für die Sie die Behandlung in UnhandledException hinzufügen müssen, oder schlimmer noch als tatsächliche Laufzeitausnahme erscheinen. Konverterimplementierungen sollten dem allgemeinen Bindungsmuster folgen, dass jede fehlerhafte Bindung nichts bewirkt und keinen Wert bereitstellt, und UnsetValue anstelle von NULL ist der Sentinelwert für diesen Fall, den die Bindungs-Engine versteht. Weitere Informationen finden Sie unter Datenbindung im Detail.

Hinweis

Zum Binden von Daten an einen benutzerdefinierten Wertkonverter, der in Visual C++-Komponentenerweiterungen (C++/CX) geschrieben ist, muss die Headerdatei, in der die IValueConverter-Implementierungsklasse definiert ist, direkt oder indirekt in eine der CodeBehind-Dateien eingeschlossen werden. Weitere Informationen finden Sie unter Erstellen Ihres ersten Mithilfe von C++.

Tipp

Zu den Standardprojektvorlagen für eine UWP-App gehört die Hilfsklasse BooleanToVisibilityConverter. Diese Klasse ist eine IValueConverter-Implementierung, die ein allgemeines Szenario für benutzerdefinierte Steuerelemente behandelt, bei dem Sie boolesche Werte aus Ihrer Steuerelementlogikklasse verwenden, um den Visibility-Wert in XAML-Steuerelementvorlagen festzulegen.

Migrationshinweise

Im Windows-Runtime verwenden die Sprachparameter für IValueConverter-Methoden Zeichenfolgen, im Gegensatz zur Verwendung von CultureInfo-Objekten wie in den Windows Presentation Foundation (WPF) und Microsoft Silverlight-Definitionen der Schnittstelle.

Methoden

Convert(Object, TypeName, Object, String)	Ändert die Quelldaten, bevor sie zur Anzeige auf der Benutzeroberfläche an das Ziel übergeben werden.
ConvertBack(Object, TypeName, Object, String)	Ändert die Zieldaten, bevor sie an das Quellobjekt übergeben werden. Diese Methode wird nur in TwoWay-Bindungen aufgerufen.

Gilt für:

Freigeben über