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

Определение

Пространство имен:

Windows.UI.Xaml.Data

Изменяет исходные данные перед их передачей в целевой объект для отображения в пользовательском интерфейсе.

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

Параметры

value

Object

Platform::Object

IInspectable

Исходные данные, передаваемые в целевой объект.

targetType

TypeName Type

Тип целевого свойства в виде ссылки на тип (System.Type для Microsoft .NET, вспомогательная структура TypeName для C++/CX и C++/WinRT).

parameter

Object

Platform::Object

IInspectable

Необязательный параметр, используемый в логике преобразователя.

language

String

Platform::String

winrt::hstring

Язык преобразования.

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

Object

Platform::Object

IInspectable

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

Примеры

В следующем примере показано, как реализовать метод 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();
        }
    }
}

Imports System.Collections.ObjectModel
Imports System.Windows.Data
Imports System.Globalization

Partial Public Class Page
    Inherits UserControl

    Public MyMusic As New ObservableCollection(Of Recording)()
    Public Sub New()
        InitializeComponent()

        ' Add items to the collection.
        MyMusic.Add(New Recording("Sheryl Crow", "Detours", New DateTime(2008, 2, 5)))
        MyMusic.Add(New Recording("Brandi Carlisle", "The Story", New DateTime(2007, 4, 3)))
        MyMusic.Add(New Recording("Patty Griffin", "Children Running Through", New DateTime(2007, 2, 6)))

        ' Set the data context for the combo box.
        MusicCombo.DataContext = MyMusic
    End Sub
End Class

' Simple business object. 
Public Class Recording
    Public Sub New()
    End Sub
    Public Sub New(ByVal artistName As String, ByVal cdName As String, _
       ByVal release As DateTime)
        Artist = artistName
        Name = cdName
        ReleaseDate = release
    End Sub
    Private artistValue As String
    Private nameValue As String
    Private releaseDateValue As DateTime
    Public Property Artist() As String
        Get
            Return artistValue
        End Get
        Set(ByVal value As String)
            artistValue = value
        End Set
    End Property
    Public Property Name() As String
        Get
            Return nameValue
        End Get
        Set(ByVal value As String)
            nameValue = value
        End Set
    End Property
    Public Property ReleaseDate() As DateTime
        Get
            Return releaseDateValue
        End Get
        Set(ByVal value As DateTime)
            releaseDateValue = value
        End Set
    End Property
End Class

Public Class DateFormatter
    Implements IValueConverter

    ' This converts the DateTime object to the string to display. 
    Public Function Convert(ByVal value As Object, ByVal targetType As Type, _
        ByVal parameter As Object, ByVal language As System.String) As Object _
        Implements IValueConverter.Convert

        ' Retrieve the format string and use it to format the value. 
        Dim formatString As String = TryCast(parameter, String)
        If Not String.IsNullOrEmpty(formatString) Then

            Return String.Format(New CultureInfo(language), formatString, value)
        End If

        ' If the format string is null or empty, simply call ToString() 
        ' on the value. 
        Return value.ToString()
    End Function

    ' No need to implement converting back on a one-way binding.
    Public Function ConvertBack(ByVal value As Object, ByVal targetType As Type, _
        ByVal parameter As Object, _
        ByVal language As System.String) As Object _
        Implements IValueConverter.ConvertBack
        Throw New NotImplementedException()
    End Function
End Class

Комментарии

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

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

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

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

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

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

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

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

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

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

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