Click here to Skip to main content
15,881,882 members
Articles / Desktop Programming / WPF

Building WPF Applications with Self-Tracking Entity Generator and Visual Studio 2012 - Project Setup

Rate me:
Please Sign up or sign in to vote.
5.00/5 (14 votes)
17 Mar 2013CPOL8 min read 68.4K   3.5K   44  
This article describes the project setup of building a WPF sample application with Self-Tracking Entity Generator and Visual Studio 2012.
//------------------------------------------------------------------------------
// <auto-generated>
//     This code was generated from a template.
//
//     Changes to this file may cause incorrect behavior and will be lost if
//     the code is regenerated.
// </auto-generated>
//------------------------------------------------------------------------------

using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Collections.Specialized;
using System.ComponentModel;
using System.ComponentModel.DataAnnotations;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Runtime.Serialization;
using System.ServiceModel;
using System.Xml.Linq;

namespace SchoolSample.EntityModel
{
    [DataContract(IsReference = true)]
    [KnownType(typeof(Student))]
    [KnownType(typeof(Instructor))]
    [KnownType(typeof(StatusEnum))]
    public abstract partial class Person: IObjectWithChangeTracker, INotifyPropertyChanged
    {
        #region Simple Properties
    
        [DataMember]
        public int PersonId
        {
            get { return _personId; }
            set
            {
                if (_personId != value)
                {
                    if (ChangeTracker.ChangeTrackingEnabled && ChangeTracker.State != ObjectState.Added)
                    {
                        throw new InvalidOperationException("The property 'PersonId' is part of the object's key and cannot be changed. Changes to key properties can only be made when the object is not being tracked or is in the Added state.");
                    }
                    PropertySetterEntry("PersonId");
                    _personId = value;
                    PropertySetterExit("PersonId", value);
                    OnPropertyChanged("PersonId");
                }
            }
        }
        private int _personId;
    
        [DataMember]
        [Display(ResourceType=typeof(SchoolSample.EntityModel.Resource.SchoolModelResource),
           Name="PersonNameField", Description="PersonNameFieldDescription")]
        [Required(ErrorMessageResourceType=typeof(SchoolSample.EntityModel.Resource.SchoolModelResource),
           ErrorMessageResourceName="FieldRequiredErrorMessage")]
        [StringLength(50, MinimumLength=0,
           ErrorMessageResourceType=typeof(SchoolSample.EntityModel.Resource.SchoolModelResource),
           ErrorMessageResourceName="FieldMaxStringLength50ErrorMessage")]
        [CustomValidation(typeof(SchoolSample.EntityModel.Person), "ValidatePersonName")]
        public string Name
        {
            get { return _name; }
            set
            {
                if (_name != value)
                {
                    ChangeTracker.RecordOriginalValue("Name", _name);
                    PropertySetterEntry("Name");
                    _name = value;
                    PropertySetterExit("Name", value);
                    OnPropertyChanged("Name");
                }
            }
        }
        private string _name;
    
        [DataMember]
        [Display(ResourceType=typeof(SchoolSample.EntityModel.Resource.SchoolModelResource),
           Name="PersonStatusField", Description="PersonStatusFieldDescription")]
        [Required(ErrorMessageResourceType=typeof(SchoolSample.EntityModel.Resource.SchoolModelResource),
           ErrorMessageResourceName="FieldRequiredErrorMessage")]
        public StatusEnum Status
        {
            get { return _status; }
            set
            {
                if (_status != value)
                {
                    ChangeTracker.RecordOriginalValue("Status", _status);
                    PropertySetterEntry("Status");
                    _status = value;
                    PropertySetterExit("Status", value);
                    OnPropertyChanged("Status");
                }
            }
        }
        private StatusEnum _status;
    
        [DataMember]
        public byte[] Version
        {
            get { return _version; }
            set
            {
                if (_version != value)
                {
                    ChangeTracker.RecordOriginalValue("Version", _version);
                    PropertySetterEntry("Version");
                    _version = value;
                    PropertySetterExit("Version", value);
                    OnPropertyChanged("Version");
                }
            }
        }
        private byte[] _version;

        #endregion

        #region ChangeTracking
    
        protected virtual void OnPropertyChanged(String propertyName)
        {
            if (ChangeTracker.State != ObjectState.Added && ChangeTracker.State != ObjectState.Deleted)
            {
                ChangeTracker.State = ObjectState.Modified;
            }
            if (_propertyChanged != null)
            {
                _propertyChanged(this, new PropertyChangedEventArgs(propertyName));
            }
        }
    
        protected virtual void OnNavigationPropertyChanged(String propertyName)
        {
            if (_propertyChanged != null)
            {
                _propertyChanged(this, new PropertyChangedEventArgs(propertyName));
            }
        }
    
        event PropertyChangedEventHandler INotifyPropertyChanged.PropertyChanged{ add { _propertyChanged += value; } remove { _propertyChanged -= value; } }
        private event PropertyChangedEventHandler _propertyChanged;
        private ObjectChangeTracker _changeTracker;
    
        [DataMember]
        public ObjectChangeTracker ChangeTracker
        {
            get
            {
                if (_changeTracker == null)
                {
                    _changeTracker = new ObjectChangeTracker();
                    _changeTracker.SetParentObject(this);
                    _changeTracker.ObjectStateChanging += HandleObjectStateChanging;
                    _changeTracker.ObjectStateChanged += HandleObjectStateChanged;
                    _changeTracker.UpdateHasChanges += HandleUpdateHasChanges;
                }
                return _changeTracker;
            }
            set
            {
                if(_changeTracker != null)
                {
                    _changeTracker.ObjectStateChanging -= HandleObjectStateChanging;
                    _changeTracker.ObjectStateChanged -= HandleObjectStateChanged;
                    _changeTracker.UpdateHasChanges -= HandleUpdateHasChanges;
                }
                _changeTracker = value;
                _changeTracker.SetParentObject(this);
                if(_changeTracker != null)
                {
                    _changeTracker.ObjectStateChanging += HandleObjectStateChanging;
                    _changeTracker.ObjectStateChanged += HandleObjectStateChanged;
                    _changeTracker.UpdateHasChanges += HandleUpdateHasChanges;
                }
            }
        }
    
        private void HandleObjectStateChanging(object sender, ObjectStateChangingEventArgs e)
        {
            if (e.NewState == ObjectState.Deleted)
            {
                ClearNavigationProperties();
            }
        }
    
        private void HandleObjectStateChanged(object sender, ObjectStateChangedEventArgs e)
        {
    #if (SILVERLIGHT || WPF)
            // update HasChanges property
            HasChanges = (ChangeTracker.State == ObjectState.Added) ||
                (ChangeTracker.ChangeTrackingEnabled &&
                (ChangeTracker.State != ObjectState.Unchanged ||
                 ChangeTracker.ObjectsAddedToCollectionProperties.Count != 0 ||
                 ChangeTracker.ObjectsRemovedFromCollectionProperties.Count != 0));
    #endif
        }
    
        private void HandleUpdateHasChanges(object sender, EventArgs e)
        {
    #if (SILVERLIGHT || WPF)
            // update HasChanges property
            HasChanges = (ChangeTracker.State == ObjectState.Added) ||
                (ChangeTracker.ChangeTrackingEnabled &&
                (ChangeTracker.State != ObjectState.Unchanged ||
                 ChangeTracker.ObjectsAddedToCollectionProperties.Count != 0 ||
                 ChangeTracker.ObjectsRemovedFromCollectionProperties.Count != 0));
    #endif
        }
    
        protected bool IsDeserializing { get; private set; }
    
        [OnDeserializing]
        public void OnDeserializingMethod(StreamingContext context)
        {
            IsDeserializing = true;
        }
    
        [OnDeserialized]
        public void OnDeserializedMethod(StreamingContext context)
        {
            IsDeserializing = false;
            ChangeTracker.ChangeTrackingEnabled = true;
        }
    
        protected virtual void ClearNavigationProperties()
        {
        }

        #endregion

        #region Validation and Helper Method
    
        /// <summary>
        /// Loops through all related data annotation attributes as well as all related
        /// custom validation actions for the specified property name. If  propertyName
        /// is String.Empty/null, the validation is on the entity level.
        /// </summary>
        /// <param name="propertyName">Propery name or String.Empty/null for top-level errors</param>
        /// <param name="value">New value that needs to be validated for the specified property</param>
        public virtual void Validate(string propertyName, object value)
        {
            // process Data Annotation Attributes
            var validationResults = new Collection<ValidationResult>();
            if (string.IsNullOrEmpty(propertyName))
            {
                // this is top-level validation
                ValidationContext context = new ValidationContext(this, null, null);
                Validator.TryValidateObject(this, context, validationResults, true);
            }
            else
            {
                PropertyInfo property = GetType().GetProperty(propertyName);
                if (property != null)
                {
                    // this is validation for each property
                    ValidationContext context = new ValidationContext(this, null, null) { MemberName = propertyName };
                    Validator.TryValidateProperty(value, context, validationResults);
                }
            }
            if (validationResults.Count != 0)
            {
    #if (SILVERLIGHT || WPF)
                foreach (ValidationResult error in validationResults)
                {
                    if (error.MemberNames.Count() == 0)
                    {
                        // this is top-level validation error
                        AddError(string.Empty, error);
                    }
                    else
                    {
                        foreach (string memberName in error.MemberNames)
                        {
                            AddError(memberName, error);
                        }
                    }
                }
    #else
                FaultReason faultReason = new FaultReason(validationResults.First().ErrorMessage);
                throw new FaultException(faultReason);
    #endif
            }
            // next, process custom validation actions
            if (ValidationActions.Count == 0) InitializeValidationSettings();
            if (string.IsNullOrEmpty(propertyName))
            {
                // loop through all properties and call its list of validation actions
                foreach (string memberName in ValidationActions.Keys.ToList())
                {
                    List<Action<object>> actions = ValidationActions[memberName];
                    if (string.IsNullOrEmpty(memberName))
                    {
                        // this is top-level validation
                        actions.ForEach(action => action(this));
                    }
                    else
                    {
                        // this is validation for each property
                        object memberValue = GetType().GetProperty(memberName).GetValue(this, null);
                        actions.ForEach(action => action(memberValue));
                    }
                }
            }
            else
            {
                if (ValidationActions.ContainsKey(propertyName))
                {
                    List<Action<object>> actions = ValidationActions[propertyName];
                    actions.ForEach(action => action(value));
                }
            }
        }
    
    #if SILVERLIGHT
        /// <summary>
        /// Client-side validation function to loop through all data annotation
        /// attributes and all custom validation actions.  If any validation fails,
        /// this function will return false. Otherwise, true.
        /// </summary>
        /// <returns></returns>
        public virtual bool TryValidate()
        {
            // clear known errors for all property names.
            ClearErrors();
            // process Data Annotation Attributes
            ValidationContext context = new ValidationContext(this, null, null);
            var validationResults = new Collection<ValidationResult>();
            Validator.TryValidateObject(this, context, validationResults, true);
            if (validationResults.Count != 0)
            {
                foreach (ValidationResult error in validationResults)
                {
                    if (error.MemberNames.Count() == 0)
                    {
                        // this is top-level validation error
                        AddError(string.Empty, error);
                    }
                    else
                    {
                        foreach (string propertyName in error.MemberNames)
                        {
                            AddError(propertyName, error);
                        }
                    }
                }
            }
            // next, process custom validation actions
            if (ValidationActions.Count == 0) InitializeValidationSettings();
            // loop through all properties and call its list of validation actions
            foreach (string propertyName in ValidationActions.Keys.ToList())
            {
                List<Action<object>> actions = ValidationActions[propertyName];
                if (string.IsNullOrEmpty(propertyName))
                {
                    // this is top-level validation
                    actions.ForEach(action => action(this));
                }
                else
                {
                    // this is validation for each property
                    object value = GetType().GetProperty(propertyName).GetValue(this, null);
                    actions.ForEach(action => action(value));
                }
            }
            return !(((INotifyDataErrorInfo)this).HasErrors);
        }
    
        /// <summary>
        /// Client-side validation function for propertyName.
        /// If any validation fails, this function will return false.
        /// Otherwise, true.
        /// </summary>
        /// <param name="propertyName"></param>
        /// <returns></returns>
        public bool TryValidate(string propertyName)
        {
            if (string.IsNullOrEmpty(propertyName))
            {
                return TryValidate();
            }
            PropertyInfo property = GetType().GetProperty(propertyName);
            if (property == null)
            {
                throw new ArgumentException(propertyName + " does not exist.");
            }
            // clear known errors for the property name
            ClearErrors(propertyName);
            // get the value of propertyName
            object value = GetType().GetProperty(propertyName).GetValue(this, null);
            Validate(propertyName, value);
            IEnumerable errors = ((INotifyDataErrorInfo)this).GetErrors(propertyName);
            if (errors == null) return true;
            int count = errors.Cast<object>().Count();
            return count == 0;
        }
    
        /// <summary>
        /// Client-side validation function to loop through the whole object
        /// graph.  If any validation fails, this function will return false. 
        /// Otherwise, true.
        /// </summary>
        /// <returns></returns>
        public bool TryValidateObjectGraph()
        {
            bool validated = true;
            var visitedGraph = new List<object>();
            TryValidateObjectGraph(ref validated, ref visitedGraph);
            return validated;
        }
    
        internal virtual void TryValidateObjectGraph(ref bool validated, ref List<object> visitedGraph)
        {
            // if already visited this object, just return
            if (visitedGraph.Any(n => ReferenceEquals(n, this))) return;
    
            if (!TryValidate()) validated = false;
            visitedGraph.Add(this);
    
            // call TryValidateObjectGraph() on all Navigation properties
            TryValidateOnNavigationProperties(ref validated, ref visitedGraph);
        }
    
        internal virtual void TryValidateOnNavigationProperties(ref bool validated, ref List<object> visitedGraph)
        {
        }
    #elif WPF
        /// <summary>
        /// Client-side validation function to loop through all data annotation
        /// attributes and all custom validation actions.  If any validation fails,
        /// this function will return false. Otherwise, true.
        /// </summary>
        /// <returns></returns>
        public virtual bool TryValidate()
        {
            // clear known errors for all property names.
            ClearErrors();
            // First, process Data Annotation Attributes
            ValidationContext context = new ValidationContext(this, null, null);
            var validationResults = new Collection<ValidationResult>();
            Validator.TryValidateObject(this, context, validationResults, true);
            if (validationResults.Count != 0)
            {
                foreach (ValidationResult error in validationResults)
                {
                    if (error.MemberNames.Count() == 0)
                    {
                        // this is top-level validation error
                        AddError(string.Empty, error);
                    }
                    else
                    {
                        foreach (string propertyName in error.MemberNames)
                        {
                            AddError(propertyName, error);
                        }
                    }
                }
            }
            // Next, process custom validation actions
            if (ValidationActions.Count == 0) InitializeValidationSettings();
            // loop through all properties and call its list of validation actions
            foreach (string propertyName in ValidationActions.Keys.ToList())
            {
                List<Action<object>> actions = ValidationActions[propertyName];
                if (string.IsNullOrEmpty(propertyName))
                {
                    // this is top-level validation
                    actions.ForEach(action => action(this));
                }
                else
                {
                    // this is validation for each property
                    object value = GetType().GetProperty(propertyName).GetValue(this, null);
                    actions.ForEach(action => action(value));
                }
            }
            return (ValidationErrors.Count == 0);
        }
    
        /// <summary>
        /// Client-side validation function for propertyName.
        /// If any validation fails, this function will return false.
        /// Otherwise, true.
        /// </summary>
        /// <param name="propertyName"></param>
        /// <returns></returns>
        public bool TryValidate(string propertyName)
        {
            if (string.IsNullOrEmpty(propertyName))
            {
                return TryValidate();
            }
            PropertyInfo property = GetType().GetProperty(propertyName);
            if (property == null)
            {
                throw new ArgumentException(propertyName + " does not exist.");
            }
            // clear known errors for the property name
            ClearErrors(propertyName);
            // get the value of propertyName
            object value = GetType().GetProperty(propertyName).GetValue(this, null);
            Validate(propertyName, value);
            return ValidationErrors.ContainsKey(propertyName);
        }
    
        /// <summary>
        /// Client-side validation function to loop through the whole object
        /// graph.  If any validation fails, this function will return false. 
        /// Otherwise, true.
        /// </summary>
        /// <returns></returns>
        public bool TryValidateObjectGraph()
        {
            bool validated = true;
            var visitedGraph = new List<object>();
            TryValidateObjectGraph(ref validated, ref visitedGraph);
            return validated;
        }
    
        internal virtual void TryValidateObjectGraph(ref bool validated, ref List<object> visitedGraph)
        {
            // if already visited this object, just return
            if (visitedGraph.Any(n => ReferenceEquals(n, this))) return;
    
            if (!TryValidate()) validated = false;
            visitedGraph.Add(this);
    
            // call TryValidateObjectGraph() on all Navigation properties
            TryValidateOnNavigationProperties(ref validated, ref visitedGraph);
        }
    
        internal virtual void TryValidateOnNavigationProperties(ref bool validated, ref List<object> visitedGraph)
        {
        }
    #else
        /// <summary>
        /// Server-side validation function to loop through all data annotation
        /// attributes and all custom validation actions.  If any validation fails,
        /// it will throw an exception.
        /// </summary>
        public virtual void Validate()
        {
            // process Data Annotation Attributes
            ValidationContext context = new ValidationContext(this, null, null);
            var validationResults = new Collection<ValidationResult>();
            Validator.TryValidateObject(this, context, validationResults, true);
            if (validationResults.Count != 0)
            {
                ValidationResult error = validationResults.First();
                if (error.MemberNames.Count() == 0)
                {
                    // this is top-level validation error
                    FaultReason faultReason = new FaultReason(error.ErrorMessage);
                    throw new FaultException(faultReason);
                }
                else
                {
                    string propertyName = error.MemberNames.First();
                    FaultReason faultReason = new FaultReason(propertyName + " : " + error.ErrorMessage);
                    throw new FaultException(faultReason);
                }
            }
            // Next, process custom validation actions
            if (ValidationActions.Count == 0) InitializeValidationSettings();
            // loop through all properties and call its list of validation actions
            foreach (string propertyName in ValidationActions.Keys.ToList())
            {
                List<Action<object>> actions = ValidationActions[propertyName];
                if (string.IsNullOrEmpty(propertyName))
                {
                    // this is top-level validation
                    actions.ForEach(action => action(this));
                }
                else
                {
                    // this is validation for each property
                    object value = GetType().GetProperty(propertyName).GetValue(this, null);
                    actions.ForEach(action => action(value));
                }
            }
        }
    
        /// <summary>
        /// Server-side validation function to loop through the whole object
        /// graph.  If any validation fails, it will throw an exception.
        /// </summary>
        /// <returns></returns>
        public void ValidateObjectGraph()
        {
            var visitedGraph = new List<object>();
            ValidateObjectGraph(ref visitedGraph);
        }
    
        internal virtual void ValidateObjectGraph(ref List<object> visitedGraph)
        {
            // if already visited this object, just return
            if (visitedGraph.Any(n => ReferenceEquals(n, this))) return;
    
            Validate();
            visitedGraph.Add(this);
    
            // call ValidateObjectGraph() on all Navigation properties
            ValidateOnNavigationProperties(ref visitedGraph);
        }
    
        internal virtual void ValidateOnNavigationProperties(ref List<object> visitedGraph)
        {
        }
    #endif
        partial void PropertySetterEntry(string propertyName);
        partial void PropertySetterExit(string propertyName, object propertyValue);
        partial void InitializeValidationSettings();
    
        private Dictionary<string, List<Action<object>>> ValidationActions
        {
            get
            {
                if (_validationActions == null)
                {
                    _validationActions = new Dictionary<string, List<Action<object>>>();
                }
                return _validationActions;
            }
        }
        private Dictionary<string, List<Action<object>>> _validationActions;
    
        /// <summary>
        /// Add one validation action for the specified property name.
        /// </summary>
        /// <param name="propertyName">Propery name or String.Empty/null for top-level errors</param>
        /// <param name="validationAction">Function to carry out a specific validation action</param>
        private void AddPropertyValidationAction(string propertyName, Action<object> validationAction)
        {
            List<Action<object>> validationActionList;
            if (!ValidationActions.ContainsKey(propertyName))
            {
                validationActionList = new List<Action<object>>();
                ValidationActions.Add(propertyName, validationActionList);
            }
            else
                validationActionList = ValidationActions[propertyName];
    
            validationActionList.Add(validationAction);
        }

        #endregion

    }
}

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)
United States United States
Weidong has been an information system professional since 1990. He has a Master's degree in Computer Science, and is currently a MCSD .NET

Comments and Discussions