Click here to Skip to main content
15,885,890 members
Articles / Desktop Programming / WPF

Building a Docking Window Management Solution in WPF

Rate me:
Please Sign up or sign in to vote.
4.28/5 (25 votes)
1 Jan 2011CPOL8 min read 187.3K   15.7K   83  
A docking window solution using WPF as part of Synergy toolkit
///
/// Copyright(C) MixModes Inc. 2010
/// 

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Collections.Specialized;
using System.ComponentModel;
using System.Reflection;
using System.Windows;

namespace MixModes.Synergy.VisualFramework.Framework
{
    /// <summary>
    /// Observable dependency property collection
    /// </summary>
    /// <typeparam name="T">Type of objects whose property is desired to be monitored</typeparam>
    public class ObservableDependencyPropertyCollection<T> : ObservableCollection<T> where T : DependencyObject
    {
        /// <summary>
        /// Occurs when dependency property has changed
        /// </summary>
        public event DependencyPropertyChangedEventHandler DependencyPropertyChanged;

        /// <summary>
        /// Initializes a new instance of the <see cref="ObservableDependencyPropertyCollection&lt;T&gt;"/> class.
        /// All the dependency properties in the inheritance hierarchy is monitored for changes
        /// </summary>
        public ObservableDependencyPropertyCollection()
        {
            MonitorAllDependencyProperties();
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ObservableDependencyPropertyCollection&lt;T&gt;"/> class.
        /// All the dependency properties in the inheritance hierarchy is monitored for changes
        /// </summary>
        /// <param name="list">Collection whose dependency properties are to be monitored</param>
        public ObservableDependencyPropertyCollection(List<T> list)
            : base(list)
        {
            MonitorAllDependencyProperties();
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ObservableDependencyPropertyCollection&lt;T&gt;"/> class.
        /// Only dependency properties specified in properties are monitored
        /// </summary>
        /// <param name="properties">Dependency properties to monitor in collection</param>
        public ObservableDependencyPropertyCollection(params DependencyProperty[] properties)
        {
            MonitorExplicitDependencyProperties(properties);
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ObservableDependencyPropertyCollection&lt;T&gt;"/> class
        /// Only dependency properties specified in properties are monitored
        /// </summary>
        /// <param name="list">Collection whose dependency properties are to be monitored</param>
        /// <param name="properties">Dependency properties to monitor in collection</param>
        public ObservableDependencyPropertyCollection(List<T> list, params DependencyProperty[] properties)
            : base(list)
        {
            MonitorExplicitDependencyProperties(properties);
        }

        /// <summary>
        /// Monitors explicit dependency properties
        /// </summary>
        /// <param name="properties">Dependency properties to monitor in collection</param>
        private void MonitorExplicitDependencyProperties(params DependencyProperty[] properties)
        {
            foreach (DependencyProperty property in properties)
            {
                CreateDescriptor(property);
            }
        }

        /// <summary>
        /// Monitors all dependency properties.
        /// </summary>
        private void MonitorAllDependencyProperties()
        {
            FieldInfo[] fieldInfos = typeof(T).GetFields(BindingFlags.Public |
                                                         BindingFlags.Static |
                                                         BindingFlags.FlattenHierarchy);

            foreach (FieldInfo fieldInfo in fieldInfos)
            {
                if (fieldInfo.FieldType == typeof(DependencyProperty))
                {
                    CreateDescriptor(fieldInfo.GetValue(null) as DependencyProperty);
                }
            }
        }

        /// <summary>
        /// Creates the descriptor for property change callback
        /// </summary>
        /// <param name="property">Dependency property whose descriptor is to be created</param>
        private void CreateDescriptor(DependencyProperty property)
        {
            ObservableDependencyProperty descriptor = new ObservableDependencyProperty(typeof(T), property, OnDependencyPropertyChanged);
            _descriptors.Add(descriptor);
        }

        /// <summary>
        /// Raises the <see cref="E:CollectionChanged"/> event.
        /// </summary>
        /// <param name="args">The <see cref="System.Collections.Specialized.NotifyCollectionChangedEventArgs"/> 
        /// instance containing the event data.</param>
        protected override void OnCollectionChanged(NotifyCollectionChangedEventArgs args)
        {
            base.OnCollectionChanged(args);

            if (args.NewItems != null)
            {
                foreach (DependencyObject obj in args.NewItems)
                {
                    foreach (ObservableDependencyProperty descriptor in _descriptors)
                    {
                        descriptor.AddValueChanged(obj);
                    }
                }
            }

            if (args.OldItems != null)
            {
                foreach (DependencyObject obj in args.OldItems)
                {
                    foreach (ObservableDependencyProperty descriptor in _descriptors)
                    {
                        descriptor.RemoveValueChanged(obj);
                    }
                }
            }
        }

        /// <summary>
        /// Called when dependency property of an item in collection has changed
        /// </summary>
        /// <param name="item">The item.</param>
        /// <param name="args">The <see cref="System.Windows.DependencyPropertyChangedEventArgs"/> instance 
        /// containing the event data.</param>
        protected void OnDependencyPropertyChanged(object item, DependencyPropertyChangedEventArgs args)
        {
            if (DependencyPropertyChanged != null)
            {
                DependencyPropertyChanged(item, args);
            }
        }        

        // Private members
        private List<ObservableDependencyProperty> _descriptors = new List<ObservableDependencyProperty>();
    }
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Software Developer (Senior) MixModes Inc. | Research In Motion
Canada Canada
Ashish worked for Microsoft for a number of years in Microsoft Visual Studio (Architect edition) and Windows Live division as a developer. Before that he was a developer consultant mainly involved in distributed service development / architecture. His main interests are distributed software architecture, patterns and practices and mobile device development.

Currently Ashish serves as a Technical Lead at RIM leading next generation BlackBerry media experience and also runs his own company MixModes Inc. specializing in .NET / WPF / Silverlight technologies. You can visit MixModes at http://mixmodes.com or follow it on Twitter @MixModes

In his free time he is an avid painter, hockey player and enjoys travelling. His blog is at: http://ashishkaila.serveblog.net

Comments and Discussions