Content update - Dependency properties overview (user story 1878471) (#1160)

* Update article and code projects * Further edits * Fix links * Relocate article & snippets to wpf/properties folder * add toc and redirects * Add acrolinx comment and make a minor edit. * minor Co-authored-by: Andy De George (adegeo) <[email protected]>
2026-09-07 23:43:19 +02:00 · 2021-09-27 13:53:44 -07:00
parent bdd178c010
commit 57b6ca1593
22 changed files with 851 additions and 0 deletions
@@ -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>
@@ -0,0 +1,17 @@
+using System;
+using System.Collections.Generic;
+using System.Configuration;
+using System.Data;
+using System.Linq;
+using System.Threading.Tasks;
+using System.Windows;
+
+namespace CodeSampleCsharp
+{
+    /// <summary>
+    /// Interaction logic for App.xaml
+    /// </summary>
+    public partial class App : Application
+    {
+    }
+}
@@ -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)
+)]
@@ -0,0 +1,38 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>WinExe</OutputType>
+    <TargetFramework>net5.0-windows</TargetFramework>
+    <UseWPF>true</UseWPF>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <None Remove="stripes.jpg" />
+    <None Remove="test.xml" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <Content Include="stripes.jpg">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Content>
+    <Content Include="test.xml">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Content>
+  </ItemGroup>
+
+  <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>
@@ -0,0 +1,90 @@
+<Window x:Class="CodeSampleCsharp.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:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
+    mc:Ignorable="d"
+    Title="Dependency Properties" Height="220" Width="300">
+    <Window.Resources>
+        <XmlDataProvider x:Key="TestData" Source="test.xml" XPath="tests"/>
+
+        <!--<SimpleStyleDefinition>-->
+        <Style x:Key="GreenButtonStyle">
+            <Setter Property="Control.Background" Value="Green"/>
+        </Style>
+        <!--</SimpleStyleDefinition>-->
+
+    </Window.Resources>
+    <StackPanel>
+
+        <!--<Resource>-->
+        <StackPanel.Resources>
+            <SolidColorBrush x:Key="MyBrush" Color="Gold"/>
+        </StackPanel.Resources>
+        <!--</Resource>-->
+
+        <!--<BasicPropertySyntax>-->
+        <Button Content="I am red" Background="Red"/>
+        <!--</BasicPropertySyntax>-->
+
+        <!--<PropertyElementSyntax>-->
+        <Button Content="I have an image background">
+            <Button.Background>
+                <ImageBrush ImageSource="stripes.jpg"/>
+            </Button.Background>
+        </Button>
+        <!--</PropertyElementSyntax>-->
+
+        <!--<ResourceReference>-->
+        <Button Background="{DynamicResource MyBrush}" Content="I am gold" />
+        <!--</ResourceReference>-->
+
+        <!--<BasicInlineBinding>-->
+        <Button Content="{Binding Source={StaticResource TestData}, XPath=test[1]/@text}"/>
+        <!--</BasicInlineBinding>-->
+
+        <!--<SimpleStyle>-->
+        <Button Style="{StaticResource GreenButtonStyle}" Content="I am green"/>
+        <!--</SimpleStyle>-->
+
+        <!--<Animate>-->
+        <Button Content="I am animated">
+            <Button.Background>
+                <SolidColorBrush x:Name="AnimBrush"/>
+            </Button.Background>
+            <Button.Triggers>
+                <EventTrigger RoutedEvent="FrameworkElement.Loaded">
+                    <BeginStoryboard>
+                        <Storyboard>
+                            <ColorAnimation
+                                Storyboard.TargetName="AnimBrush" 
+                                Storyboard.TargetProperty="(SolidColorBrush.Color)"
+                                From="Blue" To="White" Duration="0:0:1" 
+                                AutoReverse="True" RepeatBehavior="Forever" />
+                        </Storyboard>
+                    </BeginStoryboard>
+                </EventTrigger>
+            </Button.Triggers>
+        </Button>
+        <!--</Animate>-->
+
+        <!--<InheritanceBindingContext>-->
+        <StackPanel Canvas.Top="50" DataContext="{Binding Source={StaticResource TestData}}">
+            <Button Content="{Binding XPath=test[2]/@text}"/>
+        </StackPanel>
+        <!--</InheritanceBindingContext>-->
+
+        <!--<PropertyValuePrecedence>-->
+        <StackPanel>
+            <StackPanel.Resources>
+                <Style x:Key="{x:Type Button}" TargetType="{x:Type Button}">
+                    <Setter Property="Background" Value="Orange"/>
+                </Style>
+            </StackPanel.Resources>
+            <Button>I am styled orange</Button>
+            <Button Background="Pink">I am locally set to pink (not styled orange)</Button>
+        </StackPanel>
+        <!--</PropertyValuePrecedence>-->
+        
+    </StackPanel>
+</Window>
@@ -0,0 +1,48 @@
+using System.Windows;
+using System.Windows.Controls;
+
+namespace CodeSampleCsharp
+{
+    /// <summary>
+    /// Interaction logic for MainWindow.xaml.
+    /// </summary>
+    public partial class MainWindow : Window
+    {
+        public MainWindow()
+        {
+            InitializeComponent();
+
+            // <ProceduralPropertySet>
+            Button myButton = new();
+            myButton.Width = 200.0;
+            // </ProceduralPropertySet>
+
+            // <ProceduralPropertyGet>
+            double whatWidth = myButton.Width;
+            // </ProceduralPropertyGet>
+        }
+
+        // <DefineDependencyProperty>
+        public static readonly DependencyProperty IsSpinningProperty = DependencyProperty.Register(
+            "IsSpinning", typeof(bool),
+            typeof(MainWindow)
+            );
+
+        public bool IsSpinning
+        {
+            get => (bool)GetValue(IsSpinningProperty);
+            set => SetValue(IsSpinningProperty, value);
+        }
+        // </DefineDependencyProperty>
+    }
+
+    // <OverrideMetadata>
+    public class SpinnerControl : ItemsControl
+    {
+        static SpinnerControl() => DefaultStyleKeyProperty.OverrideMetadata(
+                typeof(SpinnerControl),
+                new FrameworkPropertyMetadata(typeof(SpinnerControl))
+            );
+    }
+    // </OverrideMetadata>
+}
@@ -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;
+            }
+        }
+    }
+}
@@ -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>
@@ -0,0 +1,4 @@
+<tests>
+    <test text="I have data binding content"/>
+    <test text="I have inherited data binding content"/>
+</tests>
@@ -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>
@@ -0,0 +1,6 @@
+Class Application
+
+    ' Application-level events, such as Startup, Exit, and DispatcherUnhandledException
+    ' can be handled in this file.
+
+End Class
@@ -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)>
@@ -0,0 +1,36 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>WinExe</OutputType>
+    <TargetFramework>net5.0-windows</TargetFramework>
+    <RootNamespace>CodeSampleVb</RootNamespace>
+    <UseWPF>true</UseWPF>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <None Remove="stripes.jpg" />
+    <None Remove="test.xml" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <Content Include="stripes.jpg">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Content>
+    <Content Include="test.xml">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Content>
+  </ItemGroup>
+
+  <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>
@@ -0,0 +1,90 @@
+<Window x:Class="CodeSampleVb.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:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
+    mc:Ignorable="d"
+    Title="Dependency Properties" Height="220" Width="300">
+    <Window.Resources>
+        <XmlDataProvider x:Key="TestData" Source="test.xml" XPath="tests"/>
+
+        <!--<SimpleStyleDefinition>-->
+        <Style x:Key="GreenButtonStyle">
+            <Setter Property="Control.Background" Value="Green"/>
+        </Style>
+        <!--</SimpleStyleDefinition>-->
+
+    </Window.Resources>
+    <StackPanel>
+
+        <!--<Resource>-->
+        <StackPanel.Resources>
+            <SolidColorBrush x:Key="MyBrush" Color="Gold"/>
+        </StackPanel.Resources>
+        <!--</Resource>-->
+
+        <!--<BasicPropertySyntax>-->
+        <Button Content="I am red" Background="Red"/>
+        <!--</BasicPropertySyntax>-->
+
+        <!--<PropertyElementSyntax>-->
+        <Button Content="I have an image background">
+            <Button.Background>
+                <ImageBrush ImageSource="stripes.jpg"/>
+            </Button.Background>
+        </Button>
+        <!--</PropertyElementSyntax>-->
+
+        <!--<ResourceReference>-->
+        <Button Background="{DynamicResource MyBrush}" Content="I am gold" />
+        <!--</ResourceReference>-->
+
+        <!--<BasicInlineBinding>-->
+        <Button Content="{Binding Source={StaticResource TestData}, XPath=test[1]/@text}"/>
+        <!--</BasicInlineBinding>-->
+
+        <!--<SimpleStyle>-->
+        <Button Style="{StaticResource GreenButtonStyle}" Content="I am green"/>
+        <!--</SimpleStyle>-->
+
+        <!--<Animate>-->
+        <Button Content="I am animated">
+            <Button.Background>
+                <SolidColorBrush x:Name="AnimBrush"/>
+            </Button.Background>
+            <Button.Triggers>
+                <EventTrigger RoutedEvent="FrameworkElement.Loaded">
+                    <BeginStoryboard>
+                        <Storyboard>
+                            <ColorAnimation
+                                Storyboard.TargetName="AnimBrush" 
+                                Storyboard.TargetProperty="(SolidColorBrush.Color)"
+                                From="Blue" To="White" Duration="0:0:1" 
+                                AutoReverse="True" RepeatBehavior="Forever" />
+                        </Storyboard>
+                    </BeginStoryboard>
+                </EventTrigger>
+            </Button.Triggers>
+        </Button>
+        <!--</Animate>-->
+
+        <!--<InheritanceBindingContext>-->
+        <StackPanel Canvas.Top="50" DataContext="{Binding Source={StaticResource TestData}}">
+            <Button Content="{Binding XPath=test[2]/@text}"/>
+        </StackPanel>
+        <!--</InheritanceBindingContext>-->
+
+        <!--<PropertyValuePrecedence>-->
+        <StackPanel>
+            <StackPanel.Resources>
+                <Style x:Key="{x:Type Button}" TargetType="{x:Type Button}">
+                    <Setter Property="Background" Value="Orange"/>
+                </Style>
+            </StackPanel.Resources>
+            <Button>I am styled orange</Button>
+            <Button Background="Pink">I am locally set to pink (not styled orange)</Button>
+        </StackPanel>
+        <!--</PropertyValuePrecedence>-->
+
+    </StackPanel>
+</Window>
@@ -0,0 +1,45 @@
+Namespace CodeSampleVb
+    Partial Public Class MainWindow
+        Inherits Window
+
+        Public Sub New()
+            InitializeComponent()
+
+            ' <ProceduralPropertySet>
+            Dim myButton As New Button With {
+                .Width = 200.0
+            }
+            ' </ProceduralPropertySet>
+
+            ' <ProceduralPropertyGet>
+            Dim whatWidth As Double = myButton.Width
+            ' </ProceduralPropertyGet>
+
+        End Sub
+
+        ' <DefineDependencyProperty>
+        Public Shared ReadOnly IsSpinningProperty As DependencyProperty =
+            DependencyProperty.Register("IsSpinning", GetType(Boolean), GetType(MainWindow))
+
+        Public Property IsSpinning As Boolean
+            Get
+                Return GetValue(IsSpinningProperty)
+            End Get
+            Set(value As Boolean)
+                SetValue(IsSpinningProperty, value)
+            End Set
+        End Property
+        ' </DefineDependencyProperty>
+
+    End Class
+
+    ' <OverrideMetadata>
+    Public Class SpinnerControl
+        Inherits ItemsControl
+        Shared Sub New()
+            DefaultStyleKeyProperty.OverrideMetadata(GetType(SpinnerControl), New FrameworkPropertyMetadata(GetType(SpinnerControl)))
+        End Sub
+    End Class
+    ' </OverrideMetadata>
+
+End Namespace
@@ -0,0 +1,4 @@
+<tests>
+    <test text="I have data binding content"/>
+    <test text="I have inherited data binding content"/>
+</tests>