Click here to Skip to main content
Click here to Skip to main content
Add your own
alternative version

Building an MVP Framework for .NET. Part 4: Strongly Typed Associations

, 25 Apr 2008
In this article we continue developing a Model-View-Presenter framework for .NET platform. The new features we are implementing here are strongly typed asscoiations between controllers, views and tasks for higher convenience and type safety.
mvcsharp-0.7.1.zip
MVCSharp
API Docs
CleanUpAll.proj
Examples
ASP.NET MVC Store
ApplicationLogic
Model
NorthwindDataSet.xsc
NorthwindDataSet.xss
Presentation
App_Data
Nwind.mdb
Global.asax
Properties
Tests
Properties
TestApplicationLogic
Tests.csproj.user
Basics
Basics (generics used)
ApplicationLogic
Model
Presentation
Web
Global.asax
Win
Properties
Settings.settings
ApplicationLogic
Model
Presentation
Web
Global.asax
Win
Properties
Settings.settings
SimpleFormsViewsManager
Properties
TestSimpleFormsViewsManager
ApplicationLogic
Presentation
Properties
Settings.settings
TasksInteraction
ApplicationLogic
Model
Presentation
Web
Global.asax
Win
Properties
Settings.settings
WindowsFormsExample
ApplicationLogic
Presentation
Properties
Settings.settings
MVCSharp
MVCSharp.Tests
Core
Configuration
Tasks
Views
Tasks
MVCSharp.Tests.csproj.user
Properties
Webforms
Configuration
Winforms
Configuration
Core
Configuration
Tasks
Views
Tasks
Views
Properties
Webforms
Configuration
Winforms
Configuration
//===========================================
// MVC# Framework | www.MVCSharp.org        |
// ------------------------------------------
// Copyright (C) 2008 www.MVCSharp.org      |
// All rights reserved.                     |
//===========================================

using System;
using System.Text;
using MVCSharp.Core.Tasks;
using MVCSharp.Core.Views;

namespace MVCSharp.Core
{
    #region Documentation
    /// <summary>
    /// Simple <see cref="IController"/> interface implementation
    /// with backing fields. Members are marked as virtual    
    /// so it is possible to override them in subclasses.
    /// </summary>
    /// <remarks>It is recommended to use the generic version of
    /// this class - <see cref="ControllerBase{TTask, TView}"/> -
    /// with strongly typed associations and, thus, higher type
    /// safety.</remarks>
    /// <example>ControllerBase class frees users from implementing
    /// <see cref="IController"/> manually, yet allowing to override
    /// IController members:
    /// <code>
    /// class MyController : ControllerBase
    /// {
    ///     public void MyOperation()
    ///     {
    ///         // Do something
    ///     }
    /// 
    ///     public override IView View
    ///     {
    ///         get { return base.View; }
    ///         set
    ///         {
    ///             base.View = value;
    ///             // Do view initialization
    ///         }
    ///     }
    /// }
    /// </code>
    /// </example>
    /// <seealso cref="ControllerBase{TTask, TView}"/>
    /// <seealso cref="IController"/>
    #endregion
    public class ControllerBase : IController
    {
        private ITask task;
        private IView view;

        #region Documentation
        /// <summary>
        /// Simple <see cref="IController.Task">IController.Task</see> implementation
        /// with backing field. Can be overriden in subclasses.
        /// </summary>
        /// <remarks>
        /// The setter method of the Task property is often used
        /// to do the necessary controller initialization:
        /// <code>
        /// class MyController : ControllerBase
        /// {
        ///     public override ITask Task
        ///     {
        ///         get { return base.Task; }
        ///         set
        ///         {
        ///             base.Task = value;
        ///             // Do controller initialization
        ///         }
        ///     }
        /// }
        /// </code>
        /// </remarks>
        /// <example>
        /// Here we access the task state from the controller:
        /// <code>
        /// class MyController : ControllerBase
        /// {
        ///     public void DoSomething()
        ///     {
        ///         if ((Task as MyTask).Counter >= 5)
        ///             MessageBox.Show(&quot;You cannot do something more than five times.&quot;);
        ///         else
        ///             (Task as MyTask).Counter++;
        ///     }
        /// }
        /// </code>
        /// </example>
        #endregion
        public virtual ITask Task
        {
            get { return task; }
            set { task = value; }
        }

        #region Documentation
        /// <summary>
        /// Simple <see cref="IController.View">IController.View</see> implementation
        /// with backing field. Can be overriden in subclasses.
        /// </summary>
        /// <remarks>
        /// The setter method of the View property is often used
        /// to do the necessary view initialization:
        /// <code>
        /// class MyController : ControllerBase
        /// {
        ///     public override IView View
        ///     {
        ///         get { return base.View; }
        ///         set
        ///         {
        ///             base.View = value;
        ///             // Do view initialization
        ///         }
        ///     }
        /// }
        /// </code>
        /// </remarks>
        /// <example>
        /// Here we access the view from the controller:
        /// <code>
        /// class MyController : ControllerBase
        /// {
        ///     public void DoSomething()
        ///     {
        ///         if ((View as IMyView).InputValue &lt; 0)
        ///             MessageBox.Show(&quot;The input value should be not negative.&quot;);
        ///         else
        ///             (View as IMyView).OutputValue = Math.Sqrt((View as IMyView).InputValue);
        ///     }
        /// }
        /// </code>
        /// </example>
        #endregion
        public virtual IView View
        {
            get { return view; }
            set { view = value; }
        }
    }
}

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 Microsoft Public License (Ms-PL)

About the Author

Oleg Zhukov
Team Leader
Russian Federation Russian Federation
Oleg Zhukov, born and living in Russia is Lead Engineer and Project Manager in a company which provides business software solutions. He has graduated from Moscow Institute of Physics and Technology (MIPT) (department of system programming) and has got a M.S. degree in applied physics and mathematics. His research and development work concerns architectural patterns, domain-driven development and systems analysis. Being the adherent of agile methods he applies them extensively in the projects managed by him.

| Advertise | Privacy | Mobile
Web01 | 2.8.140718.1 | Last Updated 25 Apr 2008
Article Copyright 2008 by Oleg Zhukov
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid