C:/Data/Projects/MCS EPM Global Practice/Frameworks/Public/mpfX/1.0/Applications/Client Plugins/Project Plugin/ProjectPlugin.cs

/*  ----------------------------------------------------------------------------
 *  Microsoft Corporation
 *  ----------------------------------------------------------------------------
 *  Microsoft Project Server mpFx (mpFx)
 *  ----------------------------------------------------------------------------
 *  Author: Colby Africa
 *  ----------------------------------------------------------------------------
 *  License: http://code.msdn.microsoft.com/mpFx/Project/License.aspx
 *  ----------------------------------------------------------------------------
 */

using System;
using System.Windows.Forms;
using Mcs.Epm.MicrosoftProject.mpFx.Client.Plugins.ProjectPlugin.Controls;
using Mcs.Epm.MicrosoftProject.mpFx.Client.Plugins.ProjectPlugin.Forms;
using Mcs.Epm.MicrosoftProject.mpFx.Client.Plugins.ProjectPlugin.Properties;
using Mcs.Epm.MicrosoftProject.mpFx.Client.Shared;

namespace Mcs.Epm.MicrosoftProject.mpFx.Client.Plugins.ProjectPlugin
{
    /// <summary>
    /// Implements the ProjectPlugin
    /// </summary>
    public class ProjectPlugin : IMpFxClientPlugin
    {
        #region Instance Data

        private bool _Disposed;
        private bool _IsLoaded;

        private ToolStrip _ToolStrip;
        
        private Form _Parent;
        private BrowserForm _BrowserForm;

        private ToolStripDropDownButton _ProjectsToolStripDropDownButton;
        private ToolStripMenuItem _CreateProjectToolStripMenuItem;
        private ToolStripSeparator _FirstSeparator;
        private ToolStripMenuItem _OpenBrowserToolStripMenuItem;

        #endregion

        #region Public Properties

        public ProjectServer ProjectServer { get; private set; }

        public bool IsMarkedForDeletion { get; set; }

        public Guid Guid
        {
            get
            {
                return new Guid("{48B44C33-1FFE-441b-A225-3FE0037167FD}");
            }
        }

        public Version Version
        {
            get
            {
                return new Version("1.0.0.0");
            }
        }

        public string Implementation {get;set;}

        public string Name
        {
            get
            {
                return Resources.PluginName;
            }
        }

        public string Description
        {
            get
            {
                return Resources.PluginDescription;
            }
        }

        public string Author
        {
            get
            {
                return Resources.PluginAuthor;
            }
        }

        public string Tag
        {
            get
            {
                return Resources.PluginTag;
            }
        }

        public Uri Preview
        {
            get
            {
                return new Uri(Resources.PluginPreview);
            }
        }

        public bool IsLoaded
        {
            get
            {
                return _IsLoaded;
            }
        }

        public Form MainForm
        {
            get
            {
                return null;    // Doesn't implement a main form
            }
        }

        public UserControl OptionsControl
        {
            get
            {
                return new OptionsControl(this);
            }
        }

        #endregion

        #region Public Events

        public event OnStatusChangedEventHandler OnStatusChanged;

        #endregion

        #region Public Methods

        public void OnLoad(ProjectServer projectServer, Form parent, ToolStrip toolStrip)
        {
            Tools.ValidateOnLoadParams(projectServer, parent, toolStrip);

            ProjectServer = projectServer;

            _Parent = parent;
            _ToolStrip = toolStrip;

            LoadUserInterface();

            _IsLoaded = true;
        }

        public void OnUnload()
        {
            UnloadUserInterface();

            ProjectServer = null;

            _Parent = null;
            _ToolStrip = null;

            _IsLoaded = false;
        }
        
        #endregion

        #region Private Methods

        private void LoadUserInterface()
        {
            UnloadUserInterface();

            DoOnStatusChanged(new OnStatusChangedArgs("Creating menu items... "));

            _ProjectsToolStripDropDownButton = new ToolStripDropDownButton("&Projects");

            _ToolStrip.Items.Insert(2, _ProjectsToolStripDropDownButton);

            _CreateProjectToolStripMenuItem = new ToolStripMenuItem("&Create...");

            _CreateProjectToolStripMenuItem.Click += createProjectToolStripMenuItem_Click;

            _ProjectsToolStripDropDownButton.DropDownItems.Add(_CreateProjectToolStripMenuItem);

            _FirstSeparator = new ToolStripSeparator();

            _ProjectsToolStripDropDownButton.DropDownItems.Add(_FirstSeparator);

            _OpenBrowserToolStripMenuItem = new ToolStripMenuItem("&Open Browser");

            _OpenBrowserToolStripMenuItem.Click += openBrowserToolStripMenuItem_Click;

            _ProjectsToolStripDropDownButton.DropDownItems.Add(_OpenBrowserToolStripMenuItem);

            DoOnStatusChanged(new OnStatusChangedArgs(string.Empty));
        }

        private void UnloadUserInterface()
        {
            Tools.DisposeForm(_BrowserForm);

            if (_ProjectsToolStripDropDownButton == null)
            {
                return;
            }

            Tools.CleanupToolStripItem(_ProjectsToolStripDropDownButton.DropDownItems, _CreateProjectToolStripMenuItem);
            _CreateProjectToolStripMenuItem = null;

            Tools.CleanupToolStripItem(_ProjectsToolStripDropDownButton.DropDownItems, _FirstSeparator);
            _FirstSeparator = null;

            Tools.CleanupToolStripItem(_ProjectsToolStripDropDownButton.DropDownItems, _OpenBrowserToolStripMenuItem);
            _OpenBrowserToolStripMenuItem = null;

            Tools.CleanupToolStripItem(_ProjectsToolStripDropDownButton.DropDownItems, _ProjectsToolStripDropDownButton);
            _ProjectsToolStripDropDownButton = null;
        }

        #endregion

        #region Event Handlers

        private void createProjectToolStripMenuItem_Click(object sender, EventArgs e)
        {/*  TODO: */}

        internal void DoOnStatusChanged(OnStatusChangedArgs args)
        {
            if (OnStatusChanged != null)
            {
                OnStatusChanged(this, args);
            }
        }

        void openBrowserToolStripMenuItem_Click(object sender, EventArgs e)
        {
            if (_BrowserForm == null || _BrowserForm.IsDisposed)
            {
                _BrowserForm = new BrowserForm(this);
                _BrowserForm.MdiParent = _Parent;                
            }

            _BrowserForm.Show();
        }

        #endregion

        #region IDisposable members

        ~ProjectPlugin()
        {
            Dispose(false);
        }

        public void Dispose()
        {
            Dispose(true);
            GC.SuppressFinalize(this);
        }

        private void Dispose(bool disposing)
        {
            if (_Disposed)
            {
                if (disposing)
                {
                    try
                    {
                        OnUnload();
                    }
                    catch (Exception)
                    {/* Swallow */}
                }

                _Disposed = true;
            }
        }


        #endregion
    }
}

---