IValueConverter.Convert(Object, TypeName, Object, String) Methode

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

Ändert die Quelldaten, bevor sie an das Ziel zur Anzeige auf der Benutzeroberfläche übergeben werden.

public:
 Platform::Object ^ Convert(Platform::Object ^ value, TypeName targetType, Platform::Object ^ parameter, Platform::String ^ language);

IInspectable Convert(IInspectable const& value, TypeName const& targetType, IInspectable const& parameter, winrt::hstring const& language);

public object Convert(object value, System.Type targetType, object parameter, string language);

function convert(value, targetType, parameter, language)

Public Function Convert (value As Object, targetType As Type, parameter As Object, language As String) As Object

Parameter

value: Object
Platform::Object

IInspectable

Die Quelldaten, die an das Ziel übergeben werden.

targetType: TypeName Type

Der Typ der Zieleigenschaft als Typreferenz (System.Type für Microsoft .NET, eine TypeName-Hilfsstruktur für Visual C++-Komponentenerweiterungen (C++/CX)).

parameter: Object
Platform::Object

IInspectable

Ein optionaler Parameter, der in der Konverterlogik verwendet werden soll.

language: String
Platform::String

winrt::hstring

Die Sprache der Konvertierung.

Gibt zurück

Object

Platform::Object

IInspectable

Der Wert, der an die Zielabhängigkeitseigenschaft übergeben werden soll.

Beispiele

Das folgende Beispiel zeigt, wie die Convert-Methode mithilfe des Parameters und der Sprachparameter implementiert wird.

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

Der targetType-Parameter der Convert-Methode verwendet verschiedene Techniken zum Melden der Typsysteminformationen, je nachdem, ob Sie mit Microsoft .NET oder Visual C++-Komponentenerweiterungen (C++/CX) programmieren.

Für Microsoft .NET übergibt dieser Parameter eine instance des Typs System.Type.
Für Visual C++-Komponentenerweiterungen (C++/CX) übergibt dieser Parameter einen TypeName-Strukturwert . TypeName::Kind enthält den einfachen Zeichenfolgennamen des Typs, ähnlich wie Microsoft . NET's Type.Name. Wenn der Konverter von der Bindungs-Engine aufgerufen wird, wird der targetType-Wert übergeben, indem der Eigenschaftstyp der Zielabhängigkeitseigenschaft nachgeschlagen wird. Sie können diesen Wert in Ihrer Convert-Implementierung aus einem von zwei Gründen verwenden:
Ihr Konverter hat die Erwartung, dass er immer Objekte eines bestimmten Typs zurückgibt, und Sie möchten überprüfen, ob die Bindung, für die der Konverter aufgerufen wird, den Konverter ordnungsgemäß verwendet. Andernfalls können Sie einen Fallbackwert zurückgeben oder eine Ausnahme auslösen (siehe "Ausnahmen von Konvertern" unten).
Ihr Konverter kann mehr als einen Typ zurückgeben, und Sie möchten, dass die Verwendung Ihren Konverter darüber informiert, welchen Typ er zurückgeben soll. Sie könnten beispielsweise eine Objekt-zu-Objekt-Konvertierung und eine Objekt-in-Zeichenfolge-Konvertierung innerhalb desselben Konvertercodes implementieren.

Die Sprache stammt aus dem ConverterLanguage-Wert einer bestimmten Bindung, nicht vom Systemwert. Daher sollten Sie erwarten, dass es sich um eine leere Zeichenfolge handeln könnte.

parameter stammt aus dem ConverterParameter-Wert einer bestimmten Bindung und ist standardmäßig NULL . Wenn Ihr Konverter Parameter verwendet, um die Zurückgegebenen zu ändern, erfordert dies in der Regel eine Konvention, um zu überprüfen, was von der Bindung übergeben und vom Konverter verarbeitet wird. Eine gängige Konvention besteht darin, Zeichenfolgen zu übergeben, die Modi für Ihren Konverter benennen, die zu unterschiedlichen Rückgabewerten führen. Beispielsweise verfügen Sie über die Modi "Einfach" und "Ausführlich", die unterschiedliche Längenzeichenfolgen zurückgeben, die jeweils für die Anzeige in verschiedenen Ui-Steuerelementtypen und Layouts geeignet sind.

Ausnahmen von Konvertern

Das Datenbindungsmodul fängt keine Ausnahmen ab, die von einem vom Benutzer bereitgestellten Konverter ausgelöst werden. Jede Ausnahme, die von der Convert-Methode ausgelöst wird, oder alle unausgelösten Ausnahmen, die von Methoden ausgelöst werden, die von der Convert-Methode aufgerufen werden, werden als Laufzeitfehler behandelt. Wenn Sie den Konverter in Situationen verwenden, in denen die Bindung Fallbacks verwenden oder anderweitig vernünftige Ergebnisse anzeigen kann, selbst wenn ein Konvertierungsfehler auftritt, sollten Sie erwägen, dass Ihr Konverter DependencyProperty.UnsetValue zurückgibt und keine Ausnahmen auslöst. DependencyProperty.UnsetValue ist ein Sentinelwert, der im Abhängigkeitseigenschaftensystem eine besondere Bedeutung hat, und Bindungen, die diesen Wert übergeben werden, verwenden FallbackValue.

Eine weitere Alternative zum Auslösen von Ausnahmen besteht darin, den ursprünglichen Wert unverändert zurückzugeben und die Bindung instance zu lassen, was sie mit diesem Wert tun könnte. In den meisten Fällen handelt es sich bei fehlschlagenden UI-Bindungen nicht um Fehlerfälle. Sie verwenden nur nicht den Quellwert und verwenden stattdessen DependencyProperty.UnsetValue , um nichts anzuzeigen oder Fallbacks zu verwenden.

Try/Catch basierend auf wertbasiertem Handeln ist ein gängiges Implementierungsmuster für die Convert-Methode, aber Sie sollten aus den oben genannten Gründen nicht erneut starten.

Ein Beispiel, das zeigt, wie die Convert-Methode mithilfe der Parameter - und Sprachparameter implementiert wird, finden Sie unter IValueConverter-Schnittstelle .

Gilt für:

Freigeben über