Click here to Skip to main content
15,881,882 members
Articles / Programming Languages / C#

CodeDOM Classes for Solution and Project Files (Part 5)

Rate me:
Please Sign up or sign in to vote.
5.00/5 (12 votes)
30 Nov 2012CDDL7 min read 29.9K   1.2K   18  
CodeDOM objects for VS Solution and Project files.
// The Nova Project by Ken Beckett.
// Copyright (C) 2007-2012 Inevitable Software, all rights reserved.
// Released under the Common Development and Distribution License, CDDL-1.0: http://opensource.org/licenses/cddl1.php

using System.Collections.Generic;

using Nova.CodeDOM;

namespace Nova.UI
{
    /// <summary>
    /// The view model for a <see cref="CodeDOM.Project"/>.
    /// </summary>
    public class ProjectVM : CodeObjectVM
    {
        #region /* STATICS */

        internal static void AddViewModelMapping()
        {
            CreateViewModel.Add(typeof(Project),
                delegate(CodeObject codeObject, bool isDescription, Dictionary<CodeObject, CodeObjectVM> dictionary) { return new ProjectVM((Project)codeObject, isDescription, dictionary); });
        }

        #endregion

        #region /* FIELDS */

        protected ChildListVM<CodeUnitVM> _codeUnitVMs;
        protected ChildListVM<ReferenceVM> _referenceVMs;

        #endregion

        #region /* CONSTRUCTORS */

        /// <summary>
        /// Create a view model instance for the specified <see cref="CodeDOM.Project"/>.
        /// </summary>
        public ProjectVM(Project project, bool isDescription, Dictionary<CodeObject, CodeObjectVM> dictionary)
            : base(project, dictionary)
        {
            if (!isDescription)
            {
                _codeUnitVMs = CreateListVM<CodeUnit, CodeUnitVM>(project.CodeUnits, dictionary);
                _referenceVMs = CreateListVM<Reference, ReferenceVM>(project.References, dictionary);
            }
        }

        /// <summary>
        /// Create a view model instance for the specified <see cref="CodeDOM.Project"/>.
        /// </summary>
        public ProjectVM(Project project, bool isDescription)
            : this(project, isDescription, null)
        { }

        /// <summary>
        /// Create a view model instance for the specified <see cref="CodeDOM.Project"/>.
        /// </summary>
        public ProjectVM(Project project)
            : this(project, false, null)
        { }

        #endregion

        #region /* PROPERTIES */

        /// <summary>
        /// The underlying <see cref="CodeDOM.Project"/> model.
        /// </summary>
        public Project Project
        {
            get { return (Project)CodeObject; }
        }

        /// <summary>
        /// The parent <see cref="SolutionVM"/>.
        /// </summary>
        public SolutionVM SolutionVM
        {
            get { return ParentVM as SolutionVM; }
        }

        /// <summary>
        /// All of <see cref="CodeUnitVM"/>s in the <see cref="ProjectVM"/>.
        /// </summary>
        public ChildListVM<CodeUnitVM> CodeUnits
        {
            get { return _codeUnitVMs; }
        }

        /// <summary>
        /// All of the references for the <see cref="ProjectVM"/>.
        /// </summary>
        public ChildListVM<ReferenceVM> References
        {
            get { return _referenceVMs; }
        }

        #endregion

        #region /* METHODS */

        #endregion

        #region /* RENDERING */

        public override void Render(CodeRenderer renderer, RenderFlags flags)
        {
            if (flags.HasFlag(RenderFlags.Description))
                renderer.RenderText(Project.GetRenderName(), NORMAL_BRUSH, this);
            else
                base.Render(renderer, flags);
        }

        public override void RenderToolTip(CodeRenderer renderer, RenderFlags flags)
        {
            // Don't bother displaying the type - just the file name (or path)
            string location = Project.FileName;
            if (Project.IsWebSiteProject && ParentVM != null)
            {
                string path = Project.Solution.GetWebSiteDirectory(Project.Name);
                if (path != null)
                    location = path + "\\";
            }
            if (location != null)
                renderer.RenderText(location, NORMAL_BRUSH, TextStyle.Proportional, this);

            // Display configuration and platform
            string configuration = Project.ConfigurationName;
            if (configuration != null)
            {
                string platform = Project.ConfigurationPlatform;
                if (platform != null)
                    configuration += " - " + platform;
                renderer.RenderNameValue("Configuration", configuration);
            }

            // Display target framework
            string targetFramework = Project.GetTargetFrameworkDescription();
            if (targetFramework != null)
                renderer.RenderNameValue("Target Framework", targetFramework);

            // Display any messages
            RenderMessagesInToolTip(renderer, flags);
        }

        #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 Common Development and Distribution License (CDDL)


Written By
Software Developer (Senior)
United States United States
I've been writing software since the late 70's, currently focusing mainly on C#.NET. I also like to travel around the world, and I own a Chocolate Factory (sadly, none of my employees are oompa loompas).

Comments and Discussions