Базовые инструменты WPF

В приложениях часто возникают ситуации, когда данные изменяются в коде программы и это изменение желательно увидеть в интерфейсном элементе. Проверим корректность связи от объекта-источника к целевому объекту. Для этого добавим в форму ещё одну кнопку, при нажатии на которую значение свойства ).

Проверка корректности программного изменения объекта-источника

Это является результатом того, что свойство Text элемента TextBox не уведомляется об изменении свойства Factor, которое не является свойством зависимостей. Для обеспечения уведомления между объектом-источником и целевым объектом можно поступить следующим образом:

Продемонстрируем первый и третий способ решения задачи обеспечения синхронизации представления данных между объектом-источником и целевым объектом.

Определим в классе Window1 свойство зависимостей Factor. Измененный код принимает следующий вид:

public partial class Window1 : Window
{
    public static readonly DependencyProperty FactorProperty;
    public float Factor
    {
        set{SetValue(FactorProperty, value);}
        get{return (float)GetValue(FactorProperty);}
    }
    static Window1()
    {
        FactorProperty = DependencyProperty.Register("Factor", 
       typeof(float), typeof(Window1), 
       new FrameworkPropertyMetadata (0.0F,
      FrameworkPropertyMetadataOptions.AffectsRender));
    }
    public Window1()
    {
        InitializeComponent();
    }
    private void button1_Click(object sender, RoutedEventArgs e)
    {
        MessageBox.Show(Factor.ToString(), "Проверка значения параметра");
    }
    private void button2_Click(object sender, RoutedEventArgs e)
    {
        Factor *= 2;
    }
}

Вначале определяется свойство зависимостей:

public static readonly DependencyProperty FactorProperty;

Затем формируют методы доступа к свойству зависимостей:

public float Factor
{
    set{SetValue(FactorProperty, value);}
     get{return (float)GetValue(FactorProperty);}
}

На последнем шаге свойство зависимостей регистрируется в статическом конструкторе:

static Window1()
{
    FactorProperty = DependencyProperty.Register("Factor", 
    typeof(float), typeof(Window1), 
    new FrameworkPropertyMetadata (0.0F,
   FrameworkPropertyMetadataOptions.AffectsRender));
}

Теперь при нажатии кнопки button2 изменяется значение свойства Factor и целевого объекта свойства Text элемента TextBox.

Для реализации интерфейса INotifyPropertyChanged создадим класс FactorClass:

public class FactorClass: INotifyPropertyChanged
{
  public event PropertyChangedEventHandler PropertyChanged;
  public void OnPropertyChanged(PropertyChangedEventArgs e)
  {
       if (PropertyChanged != null)
           PropertyChanged(this, e);
  }
  private float factor;
  public float Factor
  {
    get { return factor; }
    set 
    { 
      factor = value;
      OnPropertyChanged((new PropertyChangedEventArgs("Factor"));
    }
  }
}

В классе объявляется событие PropertyChanged:

event PropertyChangedEventHandler PropertyChanged;

Затем кодируется обработчик события OnPropertyChanged:

public void OnPropertyChanged(PropertyChangedEventArgs e)
  {
       if (PropertyChanged != null)
           PropertyChanged(this, e);
}

Для свойства Factor при его изменении производится генерация события:

public float Factor
  {
    get { return factor; }
    set 
    { 
      factor = value;
      OnPropertyChanged OnPropertyChanged(new
             PropertyChangedEventArgs("Factor"));
    }
  }

С учетом создания класса FactorClass код окна Window1 требует корректировки:

public partial class Window1 : Window
{
    private static FactorClass factor = new FactorClass();
    public static FactorClass Factor
    {
        get { return Window1.factor; }
    }
   
    public Window1()
    {
        InitializeComponent();
    }
    private void button1_Click(object sender, RoutedEventArgs e)
    {
        MessageBox.Show(Factor.Factor.ToString(), 
                       "Проверка значения параметра");
    }
    private void button2_Click(object sender, RoutedEventArgs e)
    {
        Factor.Factor *= 2;
    }
}

В коде окна Window1 добавляется поле и свойства Factor типа FactorClass:

private static FactorClass factor = new FactorClass();
public static FactorClass Factor
{
    get { return Window1.factor; }
}

В обработчиках кнопок обращение к свойству Factor производят через экземпляр класса FactorClass.

Тестирование внутреннего изменения значение свойства Factor и целевого объекта свойства Text элемента TextBox показывают синхронизацию изменений свойств.

При использовании класса FactorClass выражение привязки можно упростить. В этом случае создается привязка без указания источника, то есть необходимо указать только свойство Factor класса FactorClass:

<TextBox Grid.Column="1" Margin="5,5,28,15" Name="textBox1" 
Text="{Binding Path = Factor}"/>

Элемент Grid спроектированного окна является контейнером для всех визуальных элементов пользовательского интерфейса. Если свойству DataContext элемента Grid задать значение экземпляра класса FactorClass, то выражение привязки данных будет использовать общедоступные свойства класса FactorClass для заполнения себя данными. Установка свойства DataContext элемента Grid может быть сделана в конструкторе окна:

public Window1()
{
    InitializeComponent();
    gridPrimir.DataContext = Factor;
}

Проведем тестирование созданного приложения. Вначале введем значение 0.3 и проверим результат (рис 3.6).

Далее нажмем кнопку "Увеличить в 2 раза" и посмотрим реакцию приложения (рис 3.7). Приложение работает корректно.

В рассматриваемом примере поддерживается двусторонняя связь между объектом-источником и целевым объектом. В общем случае направление привязки может быть однонаправленным и двунаправленным. Это определяется свойством Binding.Mode, которое может принимать следующие значения:

Для явного задания направления привязки необходимо сформировать свойство Mode целевого объекта:

<TextBox Grid.Column="1" Margin="5,5,28,15" Name="textBox1" 
Text="{Binding Path = Factor, Mode = TwoWay}" />

При применении привязки нужно принимать во внимание режим обновления данных между источником и целевым свойством. Режим обновления задается свойством Binding.UpdateSourceTrigger, которое может принимать следующие значения:

Если нам необходимо немедленное обновление целевого свойства и источника, то необходимо добавить изменения с XAML разметку элемента TextBox:

<TextBox Grid.Column="1" Margin="5,5,28,15" Name="textBox1" 
Text="{Binding Path = Factor, Mode = TwoWay, UpdateSourceTrigger = PropertyChanged}" />

Преобразование и проверка данных

При выполнении привязки данных достаточно часто тип или представление объекта-источника и целевого объекта не совпадают, и встает задача преобразования данных. Преобразование данных может проводится неявно, когда целевой тип может представлять любое допустимое значение типа источника, но это не всегда может удовлетворять пользователя.

В технологии WPF преобразование данных используется для:

Для проектирования преобразователя значений необходимо выполнить следующее:

В случае преобразования вещественного значения в строковое можно использовать метод ToString(), а для обратного преобразования - Single.Parse().

Спроектируем класс конвертора StringToFloatConvert для преобразования строковых данных в вещественное число.

[ValueConversion(typeof(float),typeof(string))]
public class StringToFloatConvert : IValueConverter
{
    public object Convert(object value, Type typeTarget,
       object param, CultureInfo culture)
    {
        if (value != null)
         return value.ToString();
        else
            return string.Empty;
    }
    public object ConvertBack(object value, Type typeTarget,
        object param, CultureInfo culture)
    {
        if ((value != null)  (value.ToString() != ""))
            return Single.Parse(value.ToString(), NumberStyles.Float);
        else
            return 0;
    }
}

Обратите внимание на то, что для преобразования строки данных в вещественное число используется метод Single.Parse(value.ToString(), NumberStyles.Float). Данный метод преобразует строковое представление числа в указанном стиле в эквивалентное ему число одиночной точности с плавающей запятой, то есть для ввода используется не точка, а запятая.

Для подключения преобразователя необходимо к дескриптору окна добавить атрибут с отображением пространства имен проекта на префикс пространства имен XML:

xmlns:s="clr-namespace:Wpf_Primer1"

Далее необходимо создать экземпляр класса StringToFloatConvert и присвоить его свойству Convert в привязке элемента TextBox:

<TextBox Grid.Column="1" Margin="5,5,28,15" Name="textBox1">
 <TextBox.Text>
  <Binding Path="Factor" Mode="TwoWay" UpdateSourceTrigger="PropertyChanged">
      <Binding.Converter>
          <s:StringToFloatConvert />
      </Binding.Converter>
  </Binding>
 </TextBox.Text>
</TextBox>

Тестирование приложения показывает, что при вводе цифровой строки с запятой, то есть вещественного числа с плавающей запятой, например "0,3", выводится также строка "0,3" (рис 3.8). При вводе цифровой строки с точкой формируется программное прерывание методом Single.Parse(value.ToString(), NumberStyles.Float).

Теперь вернемся к вопросу проверки достоверности вводимых данных. Логика проверки достоверности вводимых данных должна перехватывать некорректные значения и отвергать их.

Технология WPF предполагает два варианта проверки достоверности данных для перехвата неверных значений:

Спроектируем правило проверки достоверности ввода данных путем создания класса ValidationFactor, который должен быть наследником класса правил ValidationRule из пространства имен System.Windows.Control:

public class ValidationFactor: ValidationRule
{
  public float Min { get; set;}
  public float Max { get; set;}
  public override ValidationResult Validate(object value,
             System.Globalization.CultureInfo cultureInfo)
  {
    try
    {
      if (((string)value).Length > 0)
        Window1.Factor.Factor = Single.Parse((string)value, 
                                        NumberStyles.Float);
      if((string)value == "")
                    Window1.Factor.Factor = 0;
    }
    catch (Exception e)
    {
      return new ValidationResult(false, " Введен недопустимый символ! ");
    }
    if ((Window1.Factor.Factor < Min) || (Window1.Factor.Factor > Max))
      return new ValidationResult(false, " Вводимое значение вне диапазона от
                                              " + Min + " до " + Max + ". ");
    else
      return new ValidationResult(true, null);
   }
}

В классе ValidationFactor определены свойства Min и Max, описывающие минимальное и максимально возможное значения вводимого вещественного числа и переопределен метод Validate() для требуемой проверки достоверности. При проверке достоверности используют перегруженную версию метода Single.Parse(), принимающего значение из перечисления NumberStyles. Это связано с тем, что проверка достоверности всегда выполняется перед преобразованием данных. Если применяется средство проверки достоверности и преобразователь к одному полю, то нужно обеспечить успех проверки достоверности. Успех или неудача логики проверки достоверности определяется возвращаемым объектом ValidationResult. Свойство IsValid указывает на успех проверки достоверности, и если проверка не прошла, то свойство ErrorContent представляет объект, описывающий ошибку.

Создадим экземпляр класса ValidationFactor и присвоим его свойству ValidationRules в привязке элемента TextBox:

<TextBox Grid.Column="1" Margin="5,5,28,15" Name="textBox1">
    <TextBox.Text>
        <Binding Path="Factor" Mode="TwoWay"
                               UpdateSourceTrigger="PropertyChanged">
            <Binding.Converter>
                <s:StringToFloatConvert />
            </Binding.Converter>
            <Binding.ValidationRules>
                <s:ValidationFactor Min="0" Max="1"/>
            </Binding.ValidationRules>
        </Binding>
    </TextBox.Text>
</TextBox>

Свойствам Min и Max класса ValidationFactor определим значения соответственно 0 и 1.

Тестирование приложения показывает, что при вводе корректного значения приложение работает правильно, а при вводе некорректного символа или числа вне интервала [0,1] происходит подсвет рамки элемента TextBox красным цветом (рис 3.9).

На рис 3.9 показан ввод недопустимого нецифрового символа и недопустимого по значению числа.

Следует отметить, что коллекция Binding.ValidationRules может состоять из неограниченного числа правил. Когда значение фиксируется в источнике, WPF будет проверять каждое правило проверки достоверности по порядку. Если все проверки достоверности пройдут успешно, то WPF вызовет преобразователь данных и применит значения к источнику. Если проверка не пройдет, то текстовое поле будет очерчено красным цветом, будут установлены свойства HasError и Error и инициируется событие Error.

Для обработки события Error необходимо установить свойство Binding.NotifyOnValidationError в True:

<Binding Path="Factor" Mode="TwoWay" UpdateSourceTrigger="PropertyChanged" 
 NotifyOnValidationError="True">

Событие Error является маршрутизируемым, использует передачу вверх и поэтому его можно обработать в родительском контейнере, например в Grid окна:

<Grid Name="gridPrimir" Height="85" Validation.Error="gridPrimir_Error">

Код обработчика будет отображать сообщение с информацией об ошибке:

private void gridPrimir_Error(object sender, ValidationErrorEventArgs e)
{
    if (e.Action == ValidationErrorEventAction.Added)
    {
        MessageBox.Show(e.Error.ErrorContent.ToString(), "Предупреждение",
                             MessageBoxButton.OK, MessageBoxImage.Warning);
    }
}

Свойство и рис 3.11 приведены реакция приложения на ввод некорректных данных.

Информацию об ошибке можно получить и другим способом. Можно отобразить сообщение об ошибке в ToolTip элемента TextBox. При этом сообщение об ошибке будет появляться, когда пользователь поместим курсор мыши над элементом TextBox. Для реализации такого варианта необходимо создать шаблон ошибок, который будет содержать триггер, реагирующий на присваивание свойству Validation.HasError значения true и применит ToolTip с сообщением об ошибке:

<Window.Resources>
  <Style TargetType="{x:Type TextBox}" >
    <Style.Triggers>
       <Trigger Property="Validation.HasError" Value="True">
          <Setter Property="ToolTip" Value=
                           "{Binding RelativeSource = {RelativeSource Self}, 
            Path = (Validation.Errors)[0].ErrorContent}" />
       </Trigger>
    </Style.Triggers>
  </Style>
</Window.Resources>

При формировании свойства и рис 3.13 приведены примеры применения подсказки для проверки ввода данных.

Ключевые термины

Свойство зависимостей, присоединяемое свойство зависимостей, маршрутизируемое событие, привязка данных, объект-источник, целевое свойство, преобразование данных, проверка достоверности вводимых данных.

DependencyProperty, FrameworkPropertyMetadata, DependencyProperty.Register, RoutedEvent, RoutedEventHandler, RoutedEventArgs, IValueConverter, ValidationRule.

Краткие итоги

Свойства зависимостей и маршрутизируемые события являются эффективными инструментами технологии WPF для построения привязки объектов и обеспечения гибкости обработки разнообразных событий в приложении. Преобразование данных расширяет возможности привязки их привязки, проверка корректности ввода обеспечивает повышение надежности работы приложения.

Ресурсы для углубленного изучения

Вопросы для самопроверки