IValueConverter.Convert(Object, TypeName, Object, String) Метод

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

Параметры

Возвращаемое значение

Значение, передаваемое свойству целевой зависимости.

Примеры

В следующем примере показано, как реализовать метод Convert с помощью параметра и языковых параметров.

//
// 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();
        }
    }
}

Комментарии

Параметр targetType метода Convert использует различные методы отправки сведений о системе типов в зависимости от того, выполняете ли вы программирование с помощью Microsoft .NET или расширений компонентов Visual C++ (C++/CX).

• Для Microsoft .NET этот параметр передает экземпляр типа System.Type .
• Для расширений компонентов Visual C++ (C++/CX) этот параметр передает значение структуры TypeName . TypeName::Kind содержит простое строковое имя типа, аналогичное Microsoft . Type.NameNET. Когда преобразователь вызывается подсистемой привязки, значение targetType передается путем поиска типа свойства целевой зависимости. Это значение можно использовать в реализации Convert по одной из двух причин:
• Преобразователь ожидает, что он всегда будет возвращать объекты определенного типа, и вы хотите убедиться, что привязка, для которой вызывается преобразователь, правильно использует преобразователь. В противном случае вы можете вернуть резервное значение или создать исключение (но см. раздел "Исключения из преобразователей" ниже).
• Преобразователь может возвращать несколько типов, и вы хотите, чтобы использование сообщило преобразователю, какой тип он должен возвращать. Например, можно реализовать преобразование объектов в объект и преобразование из объекта в строку в одном коде преобразователя.

Язык поступает из значения ConverterLanguage определенной привязки, а не системных значений, поэтому следует ожидать, что это может быть пустая строка.

Параметр поступает из значения ConverterParameter определенной привязки и по умолчанию имеет значение NULL . Если преобразователь использует параметры для изменения возвращаемого значения, обычно для этого требуется некоторое соглашение для проверки того, что передается привязкой и обрабатывается преобразователем. Распространенным соглашением является передача строк, которые называют режимы для преобразователя, которые приводят к разным возвращаемым значениям. Например, у вас могут быть режимы "Простой" и "Подробный", которые возвращают строки разной длины, которые подходят для отображения в разных типах и макетах элементов управления пользовательского интерфейса.

Исключения из преобразователей

Подсистема привязки данных не перехватывает исключения, создаваемые предоставленным пользователем преобразователем. Любое исключение, вызываемое методом Convert, или неперехваченные исключения, создаваемые методами, вызываемыми методом Convert, обрабатываются как ошибки времени выполнения. Если вы используете преобразователь в ситуациях, когда привязка может использовать резервные варианты или иным образом показывать разумные результаты, даже если происходит сбой преобразования, рекомендуется, чтобы преобразователь возвращал DependencyProperty.UnsetValue и не создавать исключения. DependencyProperty.UnsetValue — это значение sentinel, которое имеет особое значение в системе свойств зависимостей, и привязки, передаваемые этому значению, будут использовать FallbackValue.

Другой альтернативой для создания исключений является возврат исходного значения без изменений и предоставление экземпляру привязки возможности обработки того, что он может сделать с этим значением. В большинстве случаев сбой привязок пользовательского интерфейса не будет иметь ошибок. Они просто не будут использовать исходное значение и вместо этого будут использовать DependencyProperty.UnsetValue для отображения ничего или использовать резервные варианты.

Try/catch на основе выполнения какой-либо операции со значением является распространенным шаблоном реализации метода Convert, но не следует повторно выполнять по причинам, упомянутым выше.

Пример реализации метода Convert с помощью параметра и языковых параметров см. в интерфейсе IValueConverter .

Применяется к

См. также раздел

• ConvertBack(Object, TypeName, Object, String)
• Пример привязки данных XAML
• Подробно о привязке данных