mirror of
https://github.com/Stone-Red-Code/docs-desktop.git
synced 2026-09-07 23:43:19 +02:00
Content update - Dependency property callbacks and validation (user story 1878471) (#1210)
* Add article, snippets, toc, and redirects * Minor edits * Add code comments
This commit is contained in:
Tris Shores
+11
@@ -0,0 +1,11 @@
|
||||
using System.Windows;
|
||||
|
||||
namespace CodeSampleCsharp
|
||||
{
|
||||
/// <summary>
|
||||
/// Interaction logic for App.xaml
|
||||
/// </summary>
|
||||
public partial class App : Application
|
||||
{
|
||||
}
|
||||
}
|
||||
+10
@@ -0,0 +1,10 @@
|
||||
using System.Windows;
|
||||
|
||||
[assembly: ThemeInfo(
|
||||
ResourceDictionaryLocation.None, //where theme specific resource dictionaries are located
|
||||
//(used if a resource is not found in the page,
|
||||
// or application resource dictionaries)
|
||||
ResourceDictionaryLocation.SourceAssembly //where the generic resource dictionary is located
|
||||
//(used if a resource is not found in the page,
|
||||
// app, or any theme specific resource dictionaries)
|
||||
)]
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<PropertyGroup>
|
||||
<OutputType>WinExe</OutputType>
|
||||
<TargetFramework>net5.0-windows</TargetFramework>
|
||||
<UseWPF>true</UseWPF>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<Compile Update="Properties\Resources.Designer.cs">
|
||||
<DesignTime>True</DesignTime>
|
||||
<AutoGen>True</AutoGen>
|
||||
<DependentUpon>Resources.resx</DependentUpon>
|
||||
</Compile>
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<EmbeddedResource Update="Properties\Resources.resx">
|
||||
<Generator>ResXFileCodeGenerator</Generator>
|
||||
<LastGenOutput>Resources.Designer.cs</LastGenOutput>
|
||||
</EmbeddedResource>
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
+8
@@ -0,0 +1,8 @@
|
||||
<Window x:Class="CodeSampleCsharp.MainWindow"
|
||||
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
|
||||
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
|
||||
Title="Dependency property callbacks and validation" Height="200" Width="800" Loaded="RunTests">
|
||||
<Grid>
|
||||
<Label x:Name="lblMessage" HorizontalAlignment="Stretch" Margin="10" VerticalAlignment="Stretch"/>
|
||||
</Grid>
|
||||
</Window>
|
||||
+322
@@ -0,0 +1,322 @@
|
||||
using System;
|
||||
using System.Diagnostics;
|
||||
using System.Windows;
|
||||
using System.Windows.Controls;
|
||||
|
||||
namespace CodeSampleCsharp
|
||||
{
|
||||
/// <summary>
|
||||
/// Interaction logic for MainWindow.xaml.
|
||||
/// </summary>
|
||||
public partial class MainWindow : Window
|
||||
{
|
||||
public MainWindow() => InitializeComponent();
|
||||
|
||||
public void RunTests(object sender, RoutedEventArgs e)
|
||||
{
|
||||
TestValidationBehavior();
|
||||
TestCoercionBehavior();
|
||||
TestGetValueSource();
|
||||
}
|
||||
|
||||
//<TestValueValidationScenario>
|
||||
public static void TestValidationBehavior()
|
||||
{
|
||||
Gauge1 gauge = new();
|
||||
|
||||
Debug.WriteLine($"Test value validation scenario:");
|
||||
|
||||
// Set allowed value.
|
||||
gauge.CurrentReading = 5;
|
||||
Debug.WriteLine($"Current reading: {gauge.CurrentReading}");
|
||||
|
||||
try
|
||||
{
|
||||
// Set disallowed value.
|
||||
gauge.CurrentReading = double.PositiveInfinity;
|
||||
}
|
||||
catch (ArgumentException e)
|
||||
{
|
||||
Debug.WriteLine($"Exception thrown by ValidateValueCallback: {e.Message}");
|
||||
}
|
||||
|
||||
Debug.WriteLine($"Current reading: {gauge.CurrentReading}");
|
||||
|
||||
// Current reading: 5
|
||||
// Exception thrown by ValidateValueCallback: '∞' is not a valid value for property 'CurrentReading'.
|
||||
// Current reading: 5
|
||||
}
|
||||
//</TestValueValidationScenario>
|
||||
|
||||
//<TestCurrentMinMaxScenario>
|
||||
public static void TestCoercionBehavior()
|
||||
{
|
||||
Gauge2 gauge = new()
|
||||
{
|
||||
// Set initial values.
|
||||
MinReading = 0,
|
||||
MaxReading = 10,
|
||||
CurrentReading = 5
|
||||
};
|
||||
|
||||
Debug.WriteLine($"Test current/min/max values scenario:");
|
||||
|
||||
// Current reading is not coerced.
|
||||
Debug.WriteLine($"Current reading: " +
|
||||
$"{gauge.CurrentReading} (min: {gauge.MinReading}, max: {gauge.MaxReading})");
|
||||
|
||||
// Current reading is coerced to max value.
|
||||
gauge.MaxReading = 3;
|
||||
Debug.WriteLine($"Current reading: " +
|
||||
$"{gauge.CurrentReading} (min: {gauge.MinReading}, max: {gauge.MaxReading})");
|
||||
|
||||
// Current reading is coerced, but tracking back to the desired value.
|
||||
gauge.MaxReading = 4;
|
||||
Debug.WriteLine($"Current reading: " +
|
||||
$"{gauge.CurrentReading} (min: {gauge.MinReading}, max: {gauge.MaxReading})");
|
||||
|
||||
// Current reading reverts to the desired value.
|
||||
gauge.MaxReading = 10;
|
||||
Debug.WriteLine($"Current reading: " +
|
||||
$"{gauge.CurrentReading} (min: {gauge.MinReading}, max: {gauge.MaxReading})");
|
||||
|
||||
// Current reading remains at the desired value.
|
||||
gauge.MinReading = 5;
|
||||
gauge.MaxReading = 5;
|
||||
Debug.WriteLine($"Current reading: " +
|
||||
$"{gauge.CurrentReading} (min: {gauge.MinReading}, max: {gauge.MaxReading})");
|
||||
|
||||
// Current reading: 5 (min=0, max=10)
|
||||
// Current reading: 3 (min=0, max=3)
|
||||
// Current reading: 4 (min=0, max=4)
|
||||
// Current reading: 5 (min=0, max=10)
|
||||
// Current reading: 5 (min=5, max=5)
|
||||
}
|
||||
//</TestCurrentMinMaxScenario>
|
||||
|
||||
//<TestGetValueSourceScenario>
|
||||
public static void TestGetValueSource()
|
||||
{
|
||||
Gauge3 gauge = new()
|
||||
{
|
||||
// The GetValueSource method sees the first
|
||||
// locally set value as a default value (why?)
|
||||
CurrentReading = 5
|
||||
};
|
||||
|
||||
Debug.WriteLine($"Test GetValueSource scenario:");
|
||||
|
||||
// Locally set value.
|
||||
gauge.CurrentReading = 7;
|
||||
|
||||
// Locally set value is rejected.
|
||||
Debug.WriteLine($"Current reading: " +
|
||||
$"{gauge.CurrentReading}");
|
||||
|
||||
// Current reading: 5
|
||||
}
|
||||
//</TestGetValueSourceScenario>
|
||||
}
|
||||
|
||||
//<ValueValidationScenario>
|
||||
public class Gauge1 : Control
|
||||
{
|
||||
public Gauge1() : base() { }
|
||||
|
||||
// Register a dependency property with the specified property name,
|
||||
// property type, owner type, property metadata, and callbacks.
|
||||
public static readonly DependencyProperty CurrentReadingProperty =
|
||||
DependencyProperty.Register(
|
||||
name: "CurrentReading",
|
||||
propertyType: typeof(double),
|
||||
ownerType: typeof(Gauge1),
|
||||
typeMetadata: new FrameworkPropertyMetadata(
|
||||
defaultValue: double.NaN,
|
||||
flags: FrameworkPropertyMetadataOptions.AffectsMeasure),
|
||||
validateValueCallback: new ValidateValueCallback(IsValidReading));
|
||||
|
||||
// CLR wrapper with get/set accessors.
|
||||
public double CurrentReading
|
||||
{
|
||||
get => (double)GetValue(CurrentReadingProperty);
|
||||
set => SetValue(CurrentReadingProperty, value);
|
||||
}
|
||||
|
||||
// Validate-value callback.
|
||||
public static bool IsValidReading(object value)
|
||||
{
|
||||
double val = (double)value;
|
||||
return !val.Equals(double.NegativeInfinity) &&
|
||||
!val.Equals(double.PositiveInfinity);
|
||||
}
|
||||
}
|
||||
//</ValueValidationScenario>
|
||||
|
||||
//<CurrentMinMaxScenario>
|
||||
public class Gauge2 : Control
|
||||
{
|
||||
public Gauge2() : base() { }
|
||||
|
||||
// Register a dependency property with the specified property name,
|
||||
// property type, owner type, property metadata, and callbacks.
|
||||
public static readonly DependencyProperty CurrentReadingProperty =
|
||||
DependencyProperty.Register(
|
||||
name: "CurrentReading",
|
||||
propertyType: typeof(double),
|
||||
ownerType: typeof(Gauge2),
|
||||
typeMetadata: new FrameworkPropertyMetadata(
|
||||
defaultValue: double.NaN,
|
||||
flags: FrameworkPropertyMetadataOptions.AffectsMeasure,
|
||||
propertyChangedCallback: new PropertyChangedCallback(OnCurrentReadingChanged),
|
||||
coerceValueCallback: new CoerceValueCallback(CoerceCurrentReading)
|
||||
),
|
||||
validateValueCallback: new ValidateValueCallback(IsValidReading)
|
||||
);
|
||||
|
||||
// CLR wrapper with get/set accessors.
|
||||
public double CurrentReading
|
||||
{
|
||||
get => (double)GetValue(CurrentReadingProperty);
|
||||
set => SetValue(CurrentReadingProperty, value);
|
||||
}
|
||||
|
||||
// Validate-value callback.
|
||||
public static bool IsValidReading(object value)
|
||||
{
|
||||
double val = (double)value;
|
||||
return !val.Equals(double.NegativeInfinity) && !val.Equals(double.PositiveInfinity);
|
||||
}
|
||||
|
||||
// Property-changed callback.
|
||||
private static void OnCurrentReadingChanged(DependencyObject depObj, DependencyPropertyChangedEventArgs e)
|
||||
{
|
||||
depObj.CoerceValue(MinReadingProperty);
|
||||
depObj.CoerceValue(MaxReadingProperty);
|
||||
}
|
||||
|
||||
// Coerce-value callback.
|
||||
private static object CoerceCurrentReading(DependencyObject depObj, object value)
|
||||
{
|
||||
Gauge2 gauge = (Gauge2)depObj;
|
||||
double currentVal = (double)value;
|
||||
currentVal = currentVal < gauge.MinReading ? gauge.MinReading : currentVal;
|
||||
currentVal = currentVal > gauge.MaxReading ? gauge.MaxReading : currentVal;
|
||||
return currentVal;
|
||||
}
|
||||
|
||||
// Register a dependency property with the specified property name,
|
||||
// property type, owner type, property metadata, and callbacks.
|
||||
public static readonly DependencyProperty MaxReadingProperty = DependencyProperty.Register(
|
||||
name: "MaxReading",
|
||||
propertyType: typeof(double),
|
||||
ownerType: typeof(Gauge2),
|
||||
typeMetadata: new FrameworkPropertyMetadata(
|
||||
defaultValue: double.NaN,
|
||||
flags: FrameworkPropertyMetadataOptions.AffectsMeasure,
|
||||
propertyChangedCallback: new PropertyChangedCallback(OnMaxReadingChanged),
|
||||
coerceValueCallback: new CoerceValueCallback(CoerceMaxReading)
|
||||
),
|
||||
validateValueCallback: new ValidateValueCallback(IsValidReading)
|
||||
);
|
||||
|
||||
// CLR wrapper with get/set accessors.
|
||||
public double MaxReading
|
||||
{
|
||||
get => (double)GetValue(MaxReadingProperty);
|
||||
set => SetValue(MaxReadingProperty, value);
|
||||
}
|
||||
|
||||
// Property-changed callback.
|
||||
private static void OnMaxReadingChanged(DependencyObject depObj, DependencyPropertyChangedEventArgs e)
|
||||
{
|
||||
depObj.CoerceValue(MinReadingProperty);
|
||||
depObj.CoerceValue(CurrentReadingProperty);
|
||||
}
|
||||
|
||||
// Coerce-value callback.
|
||||
private static object CoerceMaxReading(DependencyObject depObj, object value)
|
||||
{
|
||||
Gauge2 gauge = (Gauge2)depObj;
|
||||
double maxVal = (double)value;
|
||||
return maxVal < gauge.MinReading ? gauge.MinReading : maxVal;
|
||||
}
|
||||
|
||||
// Register a dependency property with the specified property name,
|
||||
// property type, owner type, property metadata, and callbacks.
|
||||
public static readonly DependencyProperty MinReadingProperty = DependencyProperty.Register(
|
||||
name: "MinReading",
|
||||
propertyType: typeof(double),
|
||||
ownerType: typeof(Gauge2),
|
||||
typeMetadata: new FrameworkPropertyMetadata(
|
||||
defaultValue: double.NaN,
|
||||
flags: FrameworkPropertyMetadataOptions.AffectsMeasure,
|
||||
propertyChangedCallback: new PropertyChangedCallback(OnMinReadingChanged),
|
||||
coerceValueCallback: new CoerceValueCallback(CoerceMinReading)
|
||||
),
|
||||
validateValueCallback: new ValidateValueCallback(IsValidReading));
|
||||
|
||||
// CLR wrapper with get/set accessors.
|
||||
public double MinReading
|
||||
{
|
||||
get => (double)GetValue(MinReadingProperty);
|
||||
set => SetValue(MinReadingProperty, value);
|
||||
}
|
||||
|
||||
// Property-changed callback.
|
||||
private static void OnMinReadingChanged(DependencyObject depObj, DependencyPropertyChangedEventArgs e)
|
||||
{
|
||||
depObj.CoerceValue(MaxReadingProperty);
|
||||
depObj.CoerceValue(CurrentReadingProperty);
|
||||
}
|
||||
|
||||
// Coerce-value callback.
|
||||
private static object CoerceMinReading(DependencyObject depObj, object value)
|
||||
{
|
||||
Gauge2 gauge = (Gauge2)depObj;
|
||||
double minVal = (double)value;
|
||||
return minVal > gauge.MaxReading ? gauge.MaxReading : minVal;
|
||||
}
|
||||
}
|
||||
//</CurrentMinMaxScenario>
|
||||
|
||||
public class Gauge3 : Control
|
||||
{
|
||||
public Gauge3() : base() { }
|
||||
|
||||
// Register a dependency property with the specified property name,
|
||||
// property type, owner type, property metadata, and callbacks.
|
||||
public static readonly DependencyProperty CurrentReadingProperty =
|
||||
DependencyProperty.Register(
|
||||
name: "CurrentReading",
|
||||
propertyType: typeof(double),
|
||||
ownerType: typeof(Gauge3),
|
||||
typeMetadata: new FrameworkPropertyMetadata(
|
||||
defaultValue: double.NaN,
|
||||
flags: FrameworkPropertyMetadataOptions.AffectsMeasure,
|
||||
propertyChangedCallback: null,
|
||||
coerceValueCallback: new CoerceValueCallback(CoerceCurrentReading)
|
||||
)
|
||||
);
|
||||
|
||||
// CLR wrapper with get/set accessors.
|
||||
public double CurrentReading
|
||||
{
|
||||
get => (double)GetValue(CurrentReadingProperty);
|
||||
set => SetValue(CurrentReadingProperty, value);
|
||||
}
|
||||
|
||||
//<GetValueSourceScenario>
|
||||
// Coerce-value callback.
|
||||
private static object CoerceCurrentReading(DependencyObject depObj, object value)
|
||||
{
|
||||
// Get value source.
|
||||
ValueSource valueSource =
|
||||
DependencyPropertyHelper.GetValueSource(depObj, CurrentReadingProperty);
|
||||
|
||||
// Reject any property value change that's a locally set value.
|
||||
return valueSource.BaseValueSource == BaseValueSource.Local ?
|
||||
DependencyProperty.UnsetValue : value;
|
||||
}
|
||||
//</GetValueSourceScenario>
|
||||
}
|
||||
}
|
||||
+63
@@ -0,0 +1,63 @@
|
||||
//------------------------------------------------------------------------------
|
||||
// <auto-generated>
|
||||
// This code was generated by a tool.
|
||||
// Runtime Version:4.0.30319.42000
|
||||
//
|
||||
// Changes to this file may cause incorrect behavior and will be lost if
|
||||
// the code is regenerated.
|
||||
// </auto-generated>
|
||||
//------------------------------------------------------------------------------
|
||||
|
||||
namespace CodeSampleCsharp.Properties {
|
||||
using System;
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// A strongly-typed resource class, for looking up localized strings, etc.
|
||||
/// </summary>
|
||||
// This class was auto-generated by the StronglyTypedResourceBuilder
|
||||
// class via a tool like ResGen or Visual Studio.
|
||||
// To add or remove a member, edit your .ResX file then rerun ResGen
|
||||
// with the /str option, or rebuild your VS project.
|
||||
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "16.0.0.0")]
|
||||
[global::System.Diagnostics.DebuggerNonUserCodeAttribute()]
|
||||
[global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()]
|
||||
internal class Resources {
|
||||
|
||||
private static global::System.Resources.ResourceManager resourceMan;
|
||||
|
||||
private static global::System.Globalization.CultureInfo resourceCulture;
|
||||
|
||||
[global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")]
|
||||
internal Resources() {
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns the cached ResourceManager instance used by this class.
|
||||
/// </summary>
|
||||
[global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)]
|
||||
internal static global::System.Resources.ResourceManager ResourceManager {
|
||||
get {
|
||||
if (object.ReferenceEquals(resourceMan, null)) {
|
||||
global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("CodeSampleCsharp.Properties.Resources", typeof(Resources).Assembly);
|
||||
resourceMan = temp;
|
||||
}
|
||||
return resourceMan;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Overrides the current thread's CurrentUICulture property for all
|
||||
/// resource lookups using this strongly typed resource class.
|
||||
/// </summary>
|
||||
[global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)]
|
||||
internal static global::System.Globalization.CultureInfo Culture {
|
||||
get {
|
||||
return resourceCulture;
|
||||
}
|
||||
set {
|
||||
resourceCulture = value;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+120
@@ -0,0 +1,120 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<root>
|
||||
<!--
|
||||
Microsoft ResX Schema
|
||||
|
||||
Version 2.0
|
||||
|
||||
The primary goals of this format is to allow a simple XML format
|
||||
that is mostly human readable. The generation and parsing of the
|
||||
various data types are done through the TypeConverter classes
|
||||
associated with the data types.
|
||||
|
||||
Example:
|
||||
|
||||
... ado.net/XML headers & schema ...
|
||||
<resheader name="resmimetype">text/microsoft-resx</resheader>
|
||||
<resheader name="version">2.0</resheader>
|
||||
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
|
||||
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
|
||||
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
|
||||
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
|
||||
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
|
||||
<value>[base64 mime encoded serialized .NET Framework object]</value>
|
||||
</data>
|
||||
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
|
||||
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
|
||||
<comment>This is a comment</comment>
|
||||
</data>
|
||||
|
||||
There are any number of "resheader" rows that contain simple
|
||||
name/value pairs.
|
||||
|
||||
Each data row contains a name, and value. The row also contains a
|
||||
type or mimetype. Type corresponds to a .NET class that support
|
||||
text/value conversion through the TypeConverter architecture.
|
||||
Classes that don't support this are serialized and stored with the
|
||||
mimetype set.
|
||||
|
||||
The mimetype is used for serialized objects, and tells the
|
||||
ResXResourceReader how to depersist the object. This is currently not
|
||||
extensible. For a given mimetype the value must be set accordingly:
|
||||
|
||||
Note - application/x-microsoft.net.object.binary.base64 is the format
|
||||
that the ResXResourceWriter will generate, however the reader can
|
||||
read any of the formats listed below.
|
||||
|
||||
mimetype: application/x-microsoft.net.object.binary.base64
|
||||
value : The object must be serialized with
|
||||
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
|
||||
: and then encoded with base64 encoding.
|
||||
|
||||
mimetype: application/x-microsoft.net.object.soap.base64
|
||||
value : The object must be serialized with
|
||||
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
|
||||
: and then encoded with base64 encoding.
|
||||
|
||||
mimetype: application/x-microsoft.net.object.bytearray.base64
|
||||
value : The object must be serialized into a byte array
|
||||
: using a System.ComponentModel.TypeConverter
|
||||
: and then encoded with base64 encoding.
|
||||
-->
|
||||
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
|
||||
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
|
||||
<xsd:element name="root" msdata:IsDataSet="true">
|
||||
<xsd:complexType>
|
||||
<xsd:choice maxOccurs="unbounded">
|
||||
<xsd:element name="metadata">
|
||||
<xsd:complexType>
|
||||
<xsd:sequence>
|
||||
<xsd:element name="value" type="xsd:string" minOccurs="0" />
|
||||
</xsd:sequence>
|
||||
<xsd:attribute name="name" use="required" type="xsd:string" />
|
||||
<xsd:attribute name="type" type="xsd:string" />
|
||||
<xsd:attribute name="mimetype" type="xsd:string" />
|
||||
<xsd:attribute ref="xml:space" />
|
||||
</xsd:complexType>
|
||||
</xsd:element>
|
||||
<xsd:element name="assembly">
|
||||
<xsd:complexType>
|
||||
<xsd:attribute name="alias" type="xsd:string" />
|
||||
<xsd:attribute name="name" type="xsd:string" />
|
||||
</xsd:complexType>
|
||||
</xsd:element>
|
||||
<xsd:element name="data">
|
||||
<xsd:complexType>
|
||||
<xsd:sequence>
|
||||
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
|
||||
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
|
||||
</xsd:sequence>
|
||||
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
|
||||
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
|
||||
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
|
||||
<xsd:attribute ref="xml:space" />
|
||||
</xsd:complexType>
|
||||
</xsd:element>
|
||||
<xsd:element name="resheader">
|
||||
<xsd:complexType>
|
||||
<xsd:sequence>
|
||||
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
|
||||
</xsd:sequence>
|
||||
<xsd:attribute name="name" type="xsd:string" use="required" />
|
||||
</xsd:complexType>
|
||||
</xsd:element>
|
||||
</xsd:choice>
|
||||
</xsd:complexType>
|
||||
</xsd:element>
|
||||
</xsd:schema>
|
||||
<resheader name="resmimetype">
|
||||
<value>text/microsoft-resx</value>
|
||||
</resheader>
|
||||
<resheader name="version">
|
||||
<value>2.0</value>
|
||||
</resheader>
|
||||
<resheader name="reader">
|
||||
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
|
||||
</resheader>
|
||||
<resheader name="writer">
|
||||
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
|
||||
</resheader>
|
||||
</root>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
<Application x:Class="CodeSampleCsharp.App"
|
||||
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
|
||||
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
|
||||
xmlns:local="clr-namespace:CodeSampleCsharp"
|
||||
StartupUri="MainWindow.xaml">
|
||||
<Application.Resources>
|
||||
|
||||
</Application.Resources>
|
||||
</Application>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
<Application x:Class="Application"
|
||||
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
|
||||
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
|
||||
xmlns:local="clr-namespace:CodeSampleVb"
|
||||
StartupUri="MainWindow.xaml">
|
||||
<Application.Resources>
|
||||
|
||||
</Application.Resources>
|
||||
</Application>
|
||||
+6
@@ -0,0 +1,6 @@
|
||||
Class Application
|
||||
|
||||
' Application-level events, such as Startup, Exit, and DispatcherUnhandledException
|
||||
' can be handled in this file.
|
||||
|
||||
End Class
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
Imports System.Windows
|
||||
|
||||
'The ThemeInfo attribute describes where any theme specific and generic resource dictionaries can be found.
|
||||
'1st parameter: where theme specific resource dictionaries are located
|
||||
'(used if a resource is not found in the page,
|
||||
' or application resource dictionaries)
|
||||
|
||||
'2nd parameter: where the generic resource dictionary is located
|
||||
'(used if a resource is not found in the page,
|
||||
'app, and any theme specific resource dictionaries)
|
||||
<Assembly: ThemeInfo(ResourceDictionaryLocation.None, ResourceDictionaryLocation.SourceAssembly)>
|
||||
+22
@@ -0,0 +1,22 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<PropertyGroup>
|
||||
<OutputType>WinExe</OutputType>
|
||||
<TargetFramework>net5.0-windows</TargetFramework>
|
||||
<RootNamespace>CodeSampleVb</RootNamespace>
|
||||
<UseWPF>true</UseWPF>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<Import Include="System.Windows" />
|
||||
<Import Include="System.Windows.Controls" />
|
||||
<Import Include="System.Windows.Data" />
|
||||
<Import Include="System.Windows.Documents" />
|
||||
<Import Include="System.Windows.Input" />
|
||||
<Import Include="System.Windows.Media" />
|
||||
<Import Include="System.Windows.Media.Imaging" />
|
||||
<Import Include="System.Windows.Navigation" />
|
||||
<Import Include="System.Windows.Shapes" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
+8
@@ -0,0 +1,8 @@
|
||||
<Window x:Class="CodeSampleVb.MainWindow"
|
||||
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
|
||||
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
|
||||
Title="Dependency property callbacks and validation" Height="200" Width="800" Loaded="RunTests">
|
||||
<Grid>
|
||||
<Label x:Name="lblMessage" HorizontalAlignment="Stretch" Margin="10" VerticalAlignment="Stretch"/>
|
||||
</Grid>
|
||||
</Window>
|
||||
+321
@@ -0,0 +1,321 @@
|
||||
Namespace CodeSampleVb
|
||||
|
||||
' <summary>
|
||||
' Interaction logic for MainWindow.xaml.
|
||||
' </summary>
|
||||
Partial Public Class MainWindow
|
||||
Inherits Window
|
||||
|
||||
Public Sub New()
|
||||
InitializeComponent()
|
||||
End Sub
|
||||
|
||||
Public Sub RunTests(sender As Object, e As RoutedEventArgs)
|
||||
TestValidationBehavior()
|
||||
TestCoercionBehavior()
|
||||
TestGetValueSource()
|
||||
End Sub
|
||||
|
||||
'<TestValueValidationScenario>
|
||||
Public Shared Sub TestValidationBehavior()
|
||||
Dim gauge As New Gauge1()
|
||||
|
||||
Debug.WriteLine($"Test value validation scenario:")
|
||||
|
||||
' Set allowed value.
|
||||
gauge.CurrentReading = 5
|
||||
Debug.WriteLine($"Current reading: {gauge.CurrentReading}")
|
||||
|
||||
Try
|
||||
' Set disallowed value.
|
||||
gauge.CurrentReading = Double.PositiveInfinity
|
||||
Catch e As ArgumentException
|
||||
Debug.WriteLine($"Exception thrown by ValidateValueCallback: {e.Message}")
|
||||
End Try
|
||||
|
||||
Debug.WriteLine($"Current reading: {gauge.CurrentReading}")
|
||||
|
||||
' Current reading: 5
|
||||
' Exception thrown by ValidateValueCallback: '∞' is not a valid value for property 'CurrentReading'.
|
||||
' Current reading 5
|
||||
End Sub
|
||||
'</TestValueValidationScenario>
|
||||
|
||||
'<TestCurrentMinMaxScenario>
|
||||
Public Shared Sub TestCoercionBehavior()
|
||||
|
||||
' Set initial values.
|
||||
Dim gauge As New Gauge2 With {
|
||||
.MinReading = 0,
|
||||
.MaxReading = 10,
|
||||
.CurrentReading = 5
|
||||
}
|
||||
|
||||
Debug.WriteLine($"Test current/min/max values scenario:")
|
||||
|
||||
' Current reading is not coerced.
|
||||
Debug.WriteLine($"Current reading: " &
|
||||
$"{gauge.CurrentReading} (min={gauge.MinReading}, max={gauge.MaxReading})")
|
||||
|
||||
' Current reading is coerced to max value.
|
||||
gauge.MaxReading = 3
|
||||
Debug.WriteLine($"Current reading: " &
|
||||
$"{gauge.CurrentReading} (min={gauge.MinReading}, max={gauge.MaxReading})")
|
||||
|
||||
' Current reading is coerced, but tracking back to the desired value.
|
||||
gauge.MaxReading = 4
|
||||
Debug.WriteLine($"Current reading: " &
|
||||
$"{gauge.CurrentReading} (min={gauge.MinReading}, max={gauge.MaxReading})")
|
||||
|
||||
' Current reading reverts to the desired value.
|
||||
gauge.MaxReading = 10
|
||||
Debug.WriteLine($"Current reading: " &
|
||||
$"{gauge.CurrentReading} (min={gauge.MinReading}, max={gauge.MaxReading})")
|
||||
|
||||
' Current reading remains at the desired value.
|
||||
gauge.MinReading = 5
|
||||
gauge.MaxReading = 5
|
||||
Debug.WriteLine($"Current reading: " &
|
||||
$"{gauge.CurrentReading} (min={gauge.MinReading}, max={gauge.MaxReading})")
|
||||
|
||||
' Current reading: 5 (min=0, max=10)
|
||||
' Current reading: 3 (min=0, max=3)
|
||||
' Current reading: 4 (min=0, max=4)
|
||||
' Current reading: 5 (min=0, max=10)
|
||||
' Current reading: 5 (min=5, max=5)
|
||||
End Sub
|
||||
'</TestCurrentMinMaxScenario>
|
||||
|
||||
'<TestGetValueSourceScenario>
|
||||
Public Shared Sub TestGetValueSource()
|
||||
|
||||
Dim gauge As New Gauge3 With {
|
||||
.CurrentReading = 5
|
||||
}
|
||||
|
||||
Debug.WriteLine($"Test GetValueSource scenario:")
|
||||
|
||||
' Locally set value.
|
||||
gauge.CurrentReading = 7
|
||||
|
||||
' Locally set value is rejected.
|
||||
Debug.WriteLine($"Current reading: " &
|
||||
$"{gauge.CurrentReading}")
|
||||
|
||||
' Current reading: 5
|
||||
End Sub
|
||||
'</TestGetValueSourceScenario>
|
||||
|
||||
End Class
|
||||
|
||||
'<ValueValidationScenario>
|
||||
Public Class Gauge1
|
||||
Inherits Control
|
||||
|
||||
Public Sub New()
|
||||
MyBase.New()
|
||||
End Sub
|
||||
|
||||
Public Shared ReadOnly CurrentReadingProperty As DependencyProperty =
|
||||
DependencyProperty.Register(
|
||||
name:="CurrentReading",
|
||||
propertyType:=GetType(Double),
|
||||
ownerType:=GetType(Gauge1),
|
||||
typeMetadata:=New FrameworkPropertyMetadata(
|
||||
defaultValue:=Double.NaN,
|
||||
flags:=FrameworkPropertyMetadataOptions.AffectsMeasure),
|
||||
validateValueCallback:=New ValidateValueCallback(AddressOf IsValidReading))
|
||||
|
||||
Public Property CurrentReading As Double
|
||||
Get
|
||||
Return GetValue(CurrentReadingProperty)
|
||||
End Get
|
||||
Set(value As Double)
|
||||
SetValue(CurrentReadingProperty, value)
|
||||
End Set
|
||||
End Property
|
||||
|
||||
Public Shared Function IsValidReading(value As Object) As Boolean
|
||||
Dim val As Double = value
|
||||
Return Not val.Equals(Double.NegativeInfinity) AndAlso
|
||||
Not val.Equals(Double.PositiveInfinity)
|
||||
End Function
|
||||
|
||||
End Class
|
||||
'</ValueValidationScenario>
|
||||
|
||||
'<CurrentMinMaxScenario>
|
||||
Public Class Gauge2
|
||||
Inherits Control
|
||||
|
||||
Public Sub New()
|
||||
MyBase.New()
|
||||
End Sub
|
||||
|
||||
' Register a dependency property with the specified property name,
|
||||
' property type, owner type, property metadata, And callbacks.
|
||||
Public Shared ReadOnly CurrentReadingProperty As DependencyProperty =
|
||||
DependencyProperty.Register(
|
||||
name:="CurrentReading",
|
||||
propertyType:=GetType(Double),
|
||||
ownerType:=GetType(Gauge2),
|
||||
typeMetadata:=New FrameworkPropertyMetadata(
|
||||
defaultValue:=Double.NaN,
|
||||
flags:=FrameworkPropertyMetadataOptions.AffectsMeasure,
|
||||
propertyChangedCallback:=New PropertyChangedCallback(AddressOf OnCurrentReadingChanged),
|
||||
coerceValueCallback:=New CoerceValueCallback(AddressOf CoerceCurrentReading)),
|
||||
validateValueCallback:=New ValidateValueCallback(AddressOf IsValidReading))
|
||||
|
||||
' CLR wrapper with get/set accessors.
|
||||
Public Property CurrentReading As Double
|
||||
Get
|
||||
Return GetValue(CurrentReadingProperty)
|
||||
End Get
|
||||
Set(value As Double)
|
||||
SetValue(CurrentReadingProperty, value)
|
||||
End Set
|
||||
End Property
|
||||
|
||||
' Validate-value callback.
|
||||
Public Shared Function IsValidReading(value As Object) As Boolean
|
||||
Dim val As Double = value
|
||||
Return Not val.Equals(Double.NegativeInfinity) AndAlso Not val.Equals(Double.PositiveInfinity)
|
||||
End Function
|
||||
|
||||
' Property-changed callback.
|
||||
Private Shared Sub OnCurrentReadingChanged(depObj As DependencyObject, e As DependencyPropertyChangedEventArgs)
|
||||
depObj.CoerceValue(MinReadingProperty)
|
||||
depObj.CoerceValue(MaxReadingProperty)
|
||||
End Sub
|
||||
|
||||
' Coerce-value callback.
|
||||
Private Shared Function CoerceCurrentReading(depObj As DependencyObject, value As Object) As Object
|
||||
Dim gauge As Gauge2 = CType(depObj, Gauge2)
|
||||
Dim currentVal As Double = value
|
||||
currentVal = If(currentVal < gauge.MinReading, gauge.MinReading, currentVal)
|
||||
currentVal = If(currentVal > gauge.MaxReading, gauge.MaxReading, currentVal)
|
||||
Return currentVal
|
||||
End Function
|
||||
|
||||
'<MinMaxReadingProperty>
|
||||
Public Shared ReadOnly MaxReadingProperty As DependencyProperty =
|
||||
DependencyProperty.Register(
|
||||
name:="MaxReading",
|
||||
propertyType:=GetType(Double),
|
||||
ownerType:=GetType(Gauge2),
|
||||
typeMetadata:=New FrameworkPropertyMetadata(
|
||||
defaultValue:=Double.NaN,
|
||||
flags:=FrameworkPropertyMetadataOptions.AffectsMeasure,
|
||||
propertyChangedCallback:=New PropertyChangedCallback(AddressOf OnMaxReadingChanged),
|
||||
coerceValueCallback:=New CoerceValueCallback(AddressOf CoerceMaxReading)),
|
||||
validateValueCallback:=New ValidateValueCallback(AddressOf IsValidReading))
|
||||
|
||||
' CLR wrapper with get/set accessors.
|
||||
Public Property MaxReading As Double
|
||||
Get
|
||||
Return GetValue(MaxReadingProperty)
|
||||
End Get
|
||||
Set(value As Double)
|
||||
SetValue(MaxReadingProperty, value)
|
||||
End Set
|
||||
End Property
|
||||
|
||||
' Property-changed callback.
|
||||
Private Shared Sub OnMaxReadingChanged(depObj As DependencyObject, e As DependencyPropertyChangedEventArgs)
|
||||
depObj.CoerceValue(MinReadingProperty)
|
||||
depObj.CoerceValue(CurrentReadingProperty)
|
||||
End Sub
|
||||
|
||||
' Coerce-value callback.
|
||||
Private Shared Function CoerceMaxReading(depObj As DependencyObject, value As Object) As Object
|
||||
Dim gauge As Gauge2 = CType(depObj, Gauge2)
|
||||
Dim maxVal As Double = value
|
||||
Return If(maxVal < gauge.MinReading, gauge.MinReading, maxVal)
|
||||
End Function
|
||||
|
||||
' Register a dependency property with the specified property name,
|
||||
' property type, owner type, property metadata, And callbacks.
|
||||
Public Shared ReadOnly MinReadingProperty As DependencyProperty =
|
||||
DependencyProperty.Register(
|
||||
name:="MinReading",
|
||||
propertyType:=GetType(Double),
|
||||
ownerType:=GetType(Gauge2),
|
||||
typeMetadata:=New FrameworkPropertyMetadata(
|
||||
defaultValue:=Double.NaN,
|
||||
flags:=FrameworkPropertyMetadataOptions.AffectsMeasure,
|
||||
propertyChangedCallback:=New PropertyChangedCallback(AddressOf OnMinReadingChanged),
|
||||
coerceValueCallback:=New CoerceValueCallback(AddressOf CoerceMinReading)),
|
||||
validateValueCallback:=New ValidateValueCallback(AddressOf IsValidReading))
|
||||
|
||||
' CLR wrapper with get/set accessors.
|
||||
Public Property MinReading As Double
|
||||
Get
|
||||
Return GetValue(MinReadingProperty)
|
||||
End Get
|
||||
Set(value As Double)
|
||||
SetValue(MinReadingProperty, value)
|
||||
End Set
|
||||
End Property
|
||||
|
||||
' Property-changed callback.
|
||||
Private Shared Sub OnMinReadingChanged(depObj As DependencyObject, e As DependencyPropertyChangedEventArgs)
|
||||
depObj.CoerceValue(MaxReadingProperty)
|
||||
depObj.CoerceValue(CurrentReadingProperty)
|
||||
End Sub
|
||||
|
||||
' Coerce-value callback.
|
||||
Private Shared Function CoerceMinReading(depObj As DependencyObject, value As Object) As Object
|
||||
Dim gauge As Gauge2 = CType(depObj, Gauge2)
|
||||
Dim minVal As Double = value
|
||||
Return If(minVal > gauge.MaxReading, gauge.MaxReading, minVal)
|
||||
End Function
|
||||
'</MinMaxReadingProperty>
|
||||
|
||||
End Class
|
||||
'</CurrentMinMaxScenario>
|
||||
|
||||
Public Class Gauge3
|
||||
Inherits Control
|
||||
|
||||
Public Sub New()
|
||||
MyBase.New()
|
||||
End Sub
|
||||
|
||||
' Register a dependency property with the specified property name,
|
||||
' property type, owner type, property metadata, And callbacks.
|
||||
Public Shared ReadOnly CurrentReadingProperty As DependencyProperty =
|
||||
DependencyProperty.Register(
|
||||
name:="CurrentReading",
|
||||
propertyType:=GetType(Double),
|
||||
ownerType:=GetType(Gauge3),
|
||||
typeMetadata:=New FrameworkPropertyMetadata(
|
||||
defaultValue:=Double.NaN,
|
||||
flags:=FrameworkPropertyMetadataOptions.AffectsMeasure,
|
||||
propertyChangedCallback:=Nothing,
|
||||
coerceValueCallback:=New CoerceValueCallback(AddressOf CoerceCurrentReading)))
|
||||
|
||||
' CLR wrapper with get/set accessors.
|
||||
Public Property CurrentReading As Double
|
||||
Get
|
||||
Return GetValue(CurrentReadingProperty)
|
||||
End Get
|
||||
Set(value As Double)
|
||||
SetValue(CurrentReadingProperty, value)
|
||||
End Set
|
||||
End Property
|
||||
|
||||
'<GetValueSourceScenario>
|
||||
' Coerce-value callback.
|
||||
Private Shared Function CoerceCurrentReading(depObj As DependencyObject, value As Object) As Object
|
||||
' Get value source.
|
||||
Dim valueSource As ValueSource =
|
||||
DependencyPropertyHelper.GetValueSource(depObj, CurrentReadingProperty)
|
||||
|
||||
' Reject any property value that's a locally set value.
|
||||
Return If(valueSource.BaseValueSource = BaseValueSource.Local, DependencyProperty.UnsetValue, value)
|
||||
End Function
|
||||
'</GetValueSourceScenario>
|
||||
|
||||
End Class
|
||||
|
||||
End Namespace
|
||||
Reference in New Issue
Block a user