Click here to Skip to main content
15,891,431 members
Articles / Desktop Programming / Windows Forms

User Settings Applied

Rate me:
Please Sign up or sign in to vote.
4.95/5 (136 votes)
5 Sep 2013CPOL10 min read 543.5K   7.5K   490  
Simplifying the .NET User Configuration for Windows Forms and WPF
// -- FILE ------------------------------------------------------------------
// name       : DependencyPropertySettingCollector.cs
// created    : Jani Giannoudis - 2008.05.09
// language   : c#
// environment: .NET 2.0
// --------------------------------------------------------------------------
using System;
using System.Windows;
using System.Diagnostics;

namespace Itenso.Configuration
{

	// ------------------------------------------------------------------------
	public class DependencyPropertySettingCollector : SettingCollector
	{
		
		// ----------------------------------------------------------------------
		public DependencyPropertySettingCollector( FrameworkElement owner, DependencyProperty dependencyProperty )
		{
			if ( owner == null )
			{
				throw new ArgumentNullException( "owner" );
			}
			if ( dependencyProperty == null )
			{
				throw new ArgumentNullException( "dependencyProperty" );
			}

			this.owner = owner;
			this.dependencyProperty = dependencyProperty;
		} // DependencyPropertySettingCollector

		// ----------------------------------------------------------------------
		public FrameworkElement Owner
		{
			get { return this.owner; }
		} // Owner

		// ----------------------------------------------------------------------
		public DependencyProperty DependencyProperty
		{
			get { return this.dependencyProperty; }
		} // DependencyProperty

		// ----------------------------------------------------------------------
		public override void Collect()
		{
			Collect( this.owner, true );
		} // Collect

		// ----------------------------------------------------------------------
		private void Collect( DependencyObject currentObject, bool recursive )
		{
			foreach ( object child in LogicalTreeHelper.GetChildren( currentObject ) )
			{
				DependencyObject dependencyObject = child as DependencyObject;
				if ( dependencyObject == null )
				{
					continue;
				}

				FrameworkElement frameworkElement = child as FrameworkElement;
				if ( frameworkElement != null )
				{
					bool add = this.dependencyProperty.OwnerType.IsAssignableFrom( frameworkElement.GetType() );

					if ( add && string.IsNullOrEmpty( frameworkElement.Name ) )
					{
						add = false;
						Debug.WriteLine( "DependencyPropertySettingCollector: missing name for framework element " + frameworkElement );
					}

					if ( add && !OnCollectingSetting( frameworkElement ) )
					{
						add = false;
					}

					if ( add )
					{
						string settingName = string.Concat( frameworkElement.Name, ".", dependencyProperty.Name );
						DependencyPropertySetting dependencyPropertySetting =
							new DependencyPropertySetting( settingName, frameworkElement, dependencyProperty );
						dependencyPropertySetting.DefaultValue = dependencyPropertySetting.Value;
						ApplicationSettings.Settings.Add( dependencyPropertySetting );
					}
				}

				if ( recursive )
				{
					Collect( dependencyObject, true );
				}
			}
		} // Collect

		// ----------------------------------------------------------------------
		// members
		private readonly FrameworkElement owner;
		private readonly DependencyProperty dependencyProperty;

	} // class DependencyPropertySettingCollector

} // namespace Itenso.Configuration
// -- EOF -------------------------------------------------------------------

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)
Switzerland Switzerland
👨 Senior .NET Software Engineer

🚀 My Open Source Projects
- Time Period Library 👉 GitHub
- Payroll Engine 👉 GitHub

Feedback and contributions are welcome.



Comments and Discussions