Click here to Skip to main content
15,896,118 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 544.8K   7.5K   490  
Simplifying the .NET User Configuration for Windows Forms and WPF
// -- FILE ------------------------------------------------------------------
// name       : PropertySettingCollector.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 PropertySettingCollector : SettingCollector
	{
		
		// ----------------------------------------------------------------------
		public PropertySettingCollector( FrameworkElement owner, Type elementType, string propertyName )
		{
			if ( owner == null )
			{
				throw new ArgumentNullException( "owner" );
			}
			if ( elementType == null )
			{
				throw new ArgumentNullException( "elementType" );
			}
			if ( string.IsNullOrEmpty( propertyName ) )
			{
				throw new ArgumentNullException( "propertyName" );
			}

			this.owner = owner;
			this.elementType = elementType;
			this.propertyName = propertyName;
		} // PropertySettingCollector

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

		// ----------------------------------------------------------------------
		public Type ElementType
		{
			get { return elementType; }
		} // ElementType

		// ----------------------------------------------------------------------
		public string PropertyName
		{
			get { return propertyName; }
		} // PropertyName

		// ----------------------------------------------------------------------
		public override void Collect()
		{
			Collect( 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 )
				{
// ReSharper disable UseMethodIsInstanceOfType
					bool add = elementType.IsAssignableFrom( frameworkElement.GetType() );
// ReSharper restore UseMethodIsInstanceOfType

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

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

					if ( add )
					{
						string settingName = string.Concat( frameworkElement.Name, ".", propertyName );
						PropertySetting propertySetting = new PropertySetting( settingName, frameworkElement, propertyName );
						propertySetting.DefaultValue = propertySetting.Value;
						ApplicationSettings.Settings.Add( propertySetting );
					}
				}

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

		// ----------------------------------------------------------------------
		// members
		private readonly FrameworkElement owner;
		private readonly Type elementType;
		private readonly string propertyName;

	} // class PropertySettingCollector

} // 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