05_Березина_DependencyProperties_Base

Классы Windows Presentation Foundation
System.Object
DispatcherObject
Application
DependencyObject
NavigationService
FrameworkTemplate
Visual
ContentElement
UIElement
FrameworkContentElement
Style
FrameworkElement
Page
Shape
TextBlock
ContentControl
RangeBase
TextBoxBase
Frame
Slider
TextBox
Window
ProgressBar
RichTextBox
Grid
ItemsControl
Menu
ContextMenu
HeaderedItemsControl
MenuItem
Button
Toolbar
TreeViewItem
Selector
RepeatButton
TabControl
ToggleButton
CheckBox
Canvas
MenuBase
NavigationWindow
ButtonBase
Panel
ToolBarTray
Control
RadioButton
ListBox
ListView
TreeView
ComboBox
Свойства зависимостей (dependency properties)
 Система свойств WPF (WPF property system ) - набор сервисов, которые расширяют
функциональность свойств CLR.
 Свойства, которые управляются системой свойств WPF, называются свойствами
зависимостей (dependency properties).
 Основной функцией системы свойств WPF является вычисление значений свойств и
уведомление об изменении значений.
 Изменение значения свойства зависимостей может быть связано с различными
участниками системы свойств WPF – стилями, триггерами (triggers), наследованием
значений свойств, установкой локальных значений.
 Свойства зависимостей (dependency properties) поддерживают
• проверку корректности значений (property invalidation)
• приведение типа (dependent-value coercion)
• значения по умолчанию (default values)
• наследование (inheritance)
• привязку данных (data binding)
• анимацию (animation)
• оповещение об изменении значений (property change notification)
• cтили (styling)
Свойства зависимостей и свойства CLR
 Для свойств зависимостей из библиотек WPF определены методы {get; set},
позволяющие использовать для них обычный синтаксис CLR для свойств.
 В документации WPF есть информация о том, что свойство реализовано как свойство
зависимостей.
Например, свойство string Text { get; set; } класса TextBox определено как свойство
зависимостей, а свойство string SelectedText { get; set; } класса TextBox не является
свойством зависимостей.
 В WPF определены два класса для поддержки свойств зависимостей:
• DependencyProperty поддерживает регистрацию свойства зависимостей в сиcтеме
свойств WPF и информацию о свойствах зависимостей;
• DependencyObject используется как базовый для всех типов, в которых
определяются свойства зависимостей.
Класс DependencyProperty
System.Object
 Класс поддерживает регистрацию свойства зависимостей
в сиcтеме свойств WPF.
System.Windows.DependencyProperty
 Чтобы определить пользовательское свойство зависимости, необходимо,
• зарегистрировать его с помощью статического метода Register класса
DependencyProperty в системе свойств WPF;
• сохранить в открытом статическом поле класса (доступном только для чтения)
ссылку на объект DependencyProperty, который возвращает метод Register при
успешной регистрации.
 При регистрации можно
• определить для свойства обычные CLR методы доступа {get; set} (рекомендуется);
• с помощью объекта типа PropertyMetadata передать информацию о том, какие
службы (привязка данных, ведение журнала, …) будут использоваться с
регистрируемым свойством зависимостей.
Регистрация свойства зависимости
 Регистрацию свойства зависимостей выполняет статический метод Register класса
DependencyProperty. Метод перегружен (3). Перегруженный вариант с наибольшим числом
параметров
public static DependencyProperty Register( string name,
Type propertyType,
Type ownerType,
PropertyMetadata typeMetadata,
ValidateValueCallback validateValueCallback );
 При регистрации необходимо указать
• имя свойства (string name);
• тип свойства (Type propertyType);
• тип-владелец, в котором регистрируется свойство зависимости (Type ownerType).
 Дополнительно можно определить метаданные свойства зависимостей
(PropertyMetadata typeMetadata) и метод обратного вызова для пользовательской проверки
корректности значений свойства .
 В метаданных свойства зависимостей можно предусмотреть методы обратного вызова,
которые будут вызываться при изменении значения свойства и для анализа допустимости
(coerce) значения свойства.
Пример регистрации свойства зависимостей
public class DoubleValueTextBox : StackPanel
{
public static readonly DependencyProperty DoubleValueProperty;
static DoubleValueTextBox()
{
PropertyMetadata metadata = new PropertyMetadata(OnDoubleValueChanged);
metadata.DefaultValue = (double) double.NaN;
DoubleValueProperty =
DependencyProperty.Register("DoubleValue", typeof(double),
typeof(DoubleValueTextBox), metadata);
}
public double DoubleValue
{
get { return (double)this.GetValue(DoubleValueProperty); }
set { this.SetValue(DoubleValueProperty, value); }
}
 В примере в классе DoubleValueTextBox в статическом конструкторе зарегистрировано свойство
зависимостей с именем DoubleValue.
 Свойство имеет тип double, его владельцем является тип DoubleValueTextBox.
 Ссылка на объект DependencyProperty находится в поле DoubleValueProperty класса-владельца (как
имя статического поля класса принято использовать имя свойства, к которому добавлен корень
Property).
 Для свойства определены методы {get; set}, позволяющие использовать для него обычный синтаксис
CLR для свойств (методы GetValue и SetValue определены в классе DependencyObject).
 При регистрации для свойства задано значение NaN по умолчанию.
Класс DependencyObject
System.Object
System.Windows.Threading.DispatcherObject
System.Windows.DependencyObject
 Класс является базовым для типов, использующих
свойства зависимостей WPF.
 Метод SetValue класса DependencyObject задает
локальное значение свойства зависимостей. Метод
бросает исключение , если значение value имеет тип,
который не может быть приведен к типу, указанному при
регистрации свойства.
public Object GetValue ( DependencyProperty dp );
public void SetValue ( DependencyProperty dp, Object value );
 Метод GetValue класса DependencyObject возвращает текущее действующее значение
свойства зависимостей. Действующее значение вычисляется системой свойств WPF с
учетом всех данных, которые влияют на значение данного свойства зависимости.
Проверка корректности значения свойства
 Для проверки корректности значения свойства зависимости следует определить
отдельный метод с сигнатурой, отвечающей делегату ValidateValueCallback, который
указывается при регистрации свойства зависимости и работает как метод обратного
вызова.
public delegate bool ValidateValueCallback( Object value );
Метод выполняет пользовательскую проверку значения свойства зависимостей после
обычной проверки типа, и должен возвращать значение true, если значение свойства
принимается, и false в противном случае. Метод не предполагает корректировку значения
свойства – новое значение принимается или нет.
 Проверку корректности значения следует выполнять в отдельном методе, а не в
упаковщиках свойства { get; set}, так как
• код WPF может вызвать методы SetValue или GetValue напрямую без вызова { get;
set} ;
• значение может зависеть от других объектов, например, свойство может
унаследовать свое значение через дерево элементов или получить его в результате
привязки данных.
Присоединенные (attached) свойства зависимостей
 Присоединенные (вложенные) свойства зависимостей - это механизм, который дает
возможность присваивать значения свойствам других классов.
 Например, присоединенными свойствами зависимости являются свойства Row и Column
в классе Grid.
 Эти свойства зарегистрированы в класе Grid как присоединенные (вложенные), вызовы
методов GetValue и SetValue класса DependencyObject находятся в статических методах
класса Grid:
public static void SetRow( UIElement element, int value );
public static int GetRow( UIElement element );
 Пример использования в разметке:
<Grid Name="grid1" ShowGridLines="True">
<Grid.RowDefinitions>
<RowDefinition Height="1*" />
<RowDefinition Height="1*" />
</Grid.RowDefinitions>
<Button Grid.Row="1" Margin="5,29,5,50" Name="button1“
Click="button1_Click"> Add </Button>
</Grid>
 Пример использования в коде:
Button btn = new Button();
btn.Content = "Set";
Grid.SetRow(btn, 1);
Grid.SetColumn(btn, 1);
grid_1.Children.Add(btn);
Регистрация присоединенного свойства зависимостей
 Для регистрации присоединенного свойства зависимостей используется одна из
перегрузок метода RegisterAttached класса DependencyProperty. Перегруженный вариант с
наибольшим числом параметров
public static DependencyProperty RegisterAttached( string name,
Type propertyType,
Type ownerType,
PropertyMetadata defaultMetadata,
ValidateValueCallback validateValueCallback );
 Параметры метода имеют такой же смысл как в методе Register().
 Регистрация присоединенного свойства отличается от регистрации свойства
зависимости тем, что вызовы методов GetValue и SetValue упаковываются не в методы
{get; set }, а в статические методы с именами SetИмяСвойства() и GetИмяСвойства().