Язык программирования C#9 и платформа .NET5 - Эндрю Троелсен
Шрифт:
Интервал:
Закладка:
public partial class ShowNumberControl : UserControl
{
public ShowNumberControl()
{
InitializeComponent();
}
// Обычное свойство .NET Core.
private int _currNumber = 0;
public int CurrentNumber
{
get => _currNumber;
set
{
_currNumber = value;
numberDisplay.Content = CurrentNumber.ToString();
}
}
}
Обновите определение XAML в MainWindow.xml, объявив экземпляр специального элемента управления внутри диспетчера компоновки StackPanel. Поскольку специальный элемент управления не входит в состав основных сборок WPF, понадобится определить специальное пространство имен XML, которое отображается на него. Вот требуемая разметка:
<Window x:Class="CustomDepPropApp.MainWindow"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
xmlns:myCtrls="clr-namespace: CustomDependencyProperty"
xmlns:local="clr-namespace: CustomDependencyProperty"
mc:Ignorable="d"
Title="Simple Dependency Property App" Height="450" Width="450"
WindowStartupLocation="CenterScreen">
<StackPanel>
<myCtrls:ShowNumberControl
HorizontalAlignment="Left" x:Name="myShowNumberCtrl"
CurrentNumber="100"/>
</StackPanel>
</Window>
Похоже, что визуальный конструктор Visual Studio корректно отображает значение, установленное в свойстве CurrentNumber (рис. 25.23).
Однако что, если к свойству CurrentNumber необходимо применить объект анимации, который обеспечит изменение значения свойства от 100 до 200 в течение 10 секунд? Если это желательно сделать в разметке, тогда область myCtrls:ShowNumberControl можно изменить следующим образом:
<myCtrls:ShowNumberControl x:Name="myShowNumberCtrl" CurrentNumber="100">
<myCtrls:ShowNumberControl.Triggers>
<EventTrigger RoutedEvent = "myCtrls:ShowNumberControl.Loaded">
<EventTrigger.Actions>
<BeginStoryboard>
<Storyboard TargetProperty = "CurrentNumber">
<Int32Animation From = "100" To = "200" Duration = "0:0:10"/>
</Storyboard>
</BeginStoryboard>
</EventTrigger.Actions>
</EventTrigger>
</myCtrls:ShowNumberControl.Triggers>
</myCtrls:ShowNumberControl>
После запуска приложения объект анимации не сможет найти подходящую цель и сгенерируется исключение. Причина в том, что свойство CurrentNumber не было зарегистрировано как свойство зависимости! Чтобы устранить проблему, возвратитесь в файл кода для специального элемента управления и полностью закомментируйте текущую логику свойства (включая закрытое поддерживающее поле).
Теперь добавьте показанный ниже код, чтобы свойство CurrentNumber создавалось как свойство зависимости:
public int CurrentNumber
{
get => (int)GetValue(CurrentNumberProperty);
set => SetValue(CurrentNumberProperty, value);
}
public static readonly DependencyProperty CurrentNumberProperty =
DependencyProperty.Register("CurrentNumber",
typeof(int),
typeof(ShowNumberControl),
new UIPropertyMetadata(0));
Работа похожа на ту, что делалась в реализации свойства Height: тем не менее, предыдущий фрагмент кода регистрирует свойство непосредственно в теле, а не в статическом конструкторе (что хорошо). Также обратите внимание, что объект UIPropertyMetadata используется для определения стандартного целочисленного значения (0) вместо более сложного объекта FrameworkPropertyMetadata. В итоге получается простейшая версия CurrentNumber как свойства зависимости.
Добавление процедуры проверки достоверности данных
Хотя у вас есть свойство зависимости по имени CurrentNumber (и исключение больше не генерируется), анимация пока еще не наблюдается. Следующей корректировкой будет указание функции, вызываемой для выполнения проверки достоверности данных. В данном примере предполагается, что нужно обеспечить нахождение значения свойства CurrentNumber в диапазоне между 0 и 500.
Добавьте в метод DependencyProperty.Register() последний аргумент типа ValidateValueCallback, указывающий на метод по имени ValidateCurrentNumber.
Здесь ValidateValueCallback является делегатом, который может указывать только на методы, возвращающие тип bool и принимающие единственный аргумент типа object. Экземпляр object представляет присваиваемое новое значение. Реализация ValidateCurrentNumber должна возвращать true, если входное значение находится в ожидаемом диапазоне, и false в противном случае:
public static readonly DependencyProperty CurrentNumberProperty =
DependencyProperty.Register("CurrentNumber",
typeof(int),
typeof(ShowNumberControl),
new UIPropertyMetadata(100),
new ValidateValueCallback(ValidateCurrentNumber));
// Простое бизнес-правило: значение должно находиться
// в диапазоне между 0 и 500.
public static bool ValidateCurrentNumber(object value) =>
Convert.ToInt32(value) >= 0 && Convert.ToInt32(value) <= 500;
Реагирование на изменение свойства
Итак, допустимое число уже есть, но анимация по-прежнему отсутствует. Последнее изменение, которое потребуется внести — передать во втором аргументе конструктора UIPropertyMrtadata объект PropertyChangedCallback. Данный делегат может указывать на любой метод, принимающий DependencyObject в первом параметре и DependencyPropertyChangeEventArgs во втором. Модифицируйте код следующим образом:
// Обратите внимание на второй параметр конструктора UIPropertyMetadata.
public static readonly DependencyProperty CurrentNumberProperty =
DependencyProperty.Register("CurrentNumber", typeof(int),
typeof(ShowNumberControl),
new UIPropertyMetadata(100,
new PropertyChangedCallback(CurrentNumberChanged)),
new ValidateValueCallback(ValidateCurrentNumber));
Конечной целью внутри метода CurrentNumberChamged() будет изменение свойства Content объекта Label на новое значение, присвоенное свойству CurrentNumber. Однако возникает серьезная проблема:метод CurrentNumberChanged() является статическим, т.к. он должен работать со статическим объектом DependencyProperty. Как тогда получить доступ к объекту Label для текущего экземпляра ShowNumberControl? Нужная ссылка содержится в первом параметре DependencyObject. Новое значение можно найти с применением входных аргументов события. Ниже показан необходимый код, который будет изменять свойство Content объекта Label:
private static void CurrentNumberChanged(DependencyObject depObj,
DependencyPropertyChangedEventArgs args)
{
// Привести DependencyObject к ShowNumberControl.
ShowNumberControl c = (ShowNumberControl)depObj;
// Получить элемент управления Label в ShowNumberControl.
Label theLabel = c.numberDisplay;
// Установить для Label новое значение.
theLabel.Content = args.NewValue.ToString();
}
Видите, насколько долгий путь пришлось пройти, чтобы всего лишь изменить содержимое метки! Преимущество заключается в том, что теперь свойство зависимости CurrentNumber может быть целью для стиля WPF, объекта анимации, операции привязки данных и т.д. Снова запустив приложение, вы легко заметите, что значение изменяется во время выполнения.
На этом обзор свойств зависимости WPF завершен. Хотя теперь вы должны гораздо лучше понимать, что они позволяют делать, и как создавать собственные свойства подобного рода, имейте в виду, что многие детали здесь не были раскрыты.
Если вам однажды понадобится создавать множество собственных элементов управления, поддерживающих специальные свойства, тогда загляните в подраздел "Properties" ("Свойства") раздела "Systems" ("Системы") документации по WPF (https://docs.microsoft.com/ru-ru/dotnet/desktop/wpf/).Там вы найдете намного больше примеров построения свойств зависимости, присоединяемых свойств, разнообразных способов конфигурирования метаданных и массу других подробных сведений.
Резюме
В